ericayhayes / annotate-1 Goto Github PK

This is a Hackfest project from Access 2019, based on Marii Nyrop's Annotate demo. This version adds an instance of SimpleAnnotationServer (in a Docker container) to store the annotations, replacing the use of the browser's local storage. (In this it departs from the minimal computing commitment of the original.)

Create/store/load static annotations on IIIF manifests via Jekyll

• Ruby >=2.2
• Jekyll >=3.5
• Bundler >=1.12

• Install Docker according to the instructions for your platform.
• Clone this repository and navigate into it:
  $ git clone https://github.com/mnyrop/annotate.git && cd annotate
• Install dependencies:
  $ bundle install
• Initialize the SimpleAnnotationServer submodule:
  $ git submodule update --init --recursive
• Build and run the Docker container with the Simple Annotation Server (note: this may take several minutes, and will use a lot of network bandwidth):
  $ cd SimpleAnnotationServer && ./runDocker.sh
  The annotation server is now online at http://localhost:8888/annotation/
• To stop the Docker container:
  $ docker stop sas