Hacker’s Guide to Annotorious and RecogitoJS

We welcome pull requests to Annotorious and RecogitoJS - both to the code, as well as to our documentation! To contribute, simply fork the relevant repository and hack away. Our code is located in the following repositories

Running in Development Mode

To hack on RecogitoJS, Annotorious, or the OpenSeadragon plugin, you need to run them in development mode.

Building a distribution bundle

Hacking recogito-client-core

When working on RecogitoJS, Annotorious, or the OpenSeadragon plugin, you may need to modify code in recogito-client-core, too. To do this, you have to set up your environment so that it points to your local copy of recogito-client-core, rather than the official package published on NPM. To make this work, you have to npm link your local projects.

$ cd recogito-client-core
$ npm install 
$ npm link # Creates a global symlink
$ cd ..

$ cd annotorious
$ npm install
$ npm link @recogito/recogito-client-core # Links to the global symlink

# Annotorious now uses your local clone of recogito-client-core
# instead of the latest published NPM package
$ npm start

# Same procedure for RecogitoJS if needed