Skip to content

ercchy/h

 
 

Repository files navigation

Hypothes.is

About

Hypothes.is brings community peer review to The Internet. It is a web application which enables rich annotation of web content. The project acts as a community aggregator for annotations and identity provider1 for annotators. It also serves embed code for an annotation agent designed with modern web browsers in mind.

Installation

See INSTALL.rst for installation instructions. Platform specific instructions can be found in the install documents as well.

Running

Installation has, hopefully, gone smoothly. If you ran into any problems, be sure to seek help on IRC or the mailing list. To run the server, simply use the run command:

$ ./run

This command will start the server on port 5000 (https://localhost:5000), reload the application whenever changes are made to the source code, and restart it should it crash for some reason.

Note

Using the bookmarklet or otherwise embedding the application may not be possible on sites accessed via HTTPS due to browser policy restricting the inclusion of non-SSL content. If you wish to test the development server with these sites uncomment the line beginning with "certfile" in the development server configuration file, "development.ini". This will cause the server to use a self-signed certificate included for testing.

Development

The project builds heavily on components developed for the Annotator Project and is structured to encourage upstream contribution where possible. However, work is required to make Annotator more extensible in order to facilitate contribution.

Additionally, work is underway to support the data model described by the Open Annotation Core specification document.

See the project wiki for the roadmap and additional information and join us in #hypothes.is on freenode for discussion.

Those wishing to contribute to the project should also subscribe to the development mailing list and read about contributing. Then consider getting started on one of the issues that are ready for work by clicking on the badge below. Issues tagged with the label 'cake' are ideal for new contributors.

Stories in Ready

Build Status

Testing

To run the test suite, ensure the assets are built and then invoke the tests in the usual fashion of Python:

$ ./bin/python setup.py test

As a convenience, there is a make target for this:

$ make test

Chrome Extension

To build the Chrome extension, follow the installation instructions and then check out and build the pdf.js submodule:

$ git submodule init
$ git submodule update
$ cd pdf.js
$ node make generic
$ node make chromium

Then, run the following command at the prompt to build the extension:

$ ./bin/hypothesis extension development.ini http://localhost:5000

If you are managing your virtual environment yourself, the script may not be located in the bin directory, but should be available in your path when the virtual environment is activated.

The third argument is the base URL for the application. An optional, fourth argument may be passed to override the URL prefix used for static assets.

At this point, a working extension should exist in ./build/chrome but with the development configuration the static assets are still loaded from the server. Start the application and ensure that the assets are built by visiting the home page or by running ./bin/hypothesis assets.

Note: Bundling the assets in the extension only works at the moment when the webassets.debug setting is falsy.

Deployment

Deployment is mostly left as an exercise to the reader until we document this better. Using Docker it is easy to configure the ElasticSearch host and the mail relay address. Simply create links with the names elasticsearch and mail respectively.

License

Hypothes.is is released under the 2-Clause BSD License, sometimes referred to as the "Simplified BSD License" or the "FreeBSD License". Some third-party components are included. They are subject to their own licenses. All of the license information can be found in the included LICENSE file.


  1. Community and identity features are not finished. Get involved and help!

About

The Internet, peer reviewed.

Resources

License

Stars

Watchers

Forks

Packages

No packages published