Skip to content

Latest commit

 

History

History
47 lines (38 loc) · 2.11 KB

INSTALL.rst

File metadata and controls

47 lines (38 loc) · 2.11 KB

Installing Hypothes.is

Hypothes.is currently requires several tools to build and run from scratch.

See the platform specific INSTALL.<platform>.rst files for more information about how to install the dependencies on any specific platform.

In the future, releases will include built versions of static assets for integrators wanting to produce custom embeddings of the project on their own sites and the project welcomes packaging efforts to make including the Hypothes.is service in any framework easy.

The project code itself is a pyramid application which can be integrated into any WSGI_ compatible framework and run on any WSGI web server (such as gunicorn or uWSGI). Until the project is ready for an alpha release, it may not be installable from the Python Package Index. Instead, the application should be built in a virtual environment which can be set up as follows:

$ ./bootstrap

The command will set up the development environment and check for development dependencies. Warnings will be issued for missing dependencies. When this script runs successfully, the environment should be prepared. It is good practice to run this script whenever the source code changes, such as after pulling new commits from upstream, or checking out a new branch, which may have changed (for example: updated) requirements.

For building the static assets, requirements currently include CoffeeScript and Sass with Compass installed. These tools are widely available in package repositories. Check the platform-specific installation instructions for details.

For production use, the application will use UglifyJS and clean-css for minification needs. These are not required when running the project in a development configuration.