Skip to content

davidmcclure/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.

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 run the server, reloading the application whenever changes are made to the source code, and restarting it should it crash for some reason.

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.

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

Languages

  • JavaScript 84.3%
  • CoffeeScript 7.9%
  • Python 7.3%
  • Shell 0.5%