Arethusa: Annotation Environment
Be sure to check out our wiki for design documentation.
Code documentation is in progress - to build the docs run the
grunt ngdocs task.
sudo npm install grunt-cli -g sudo npm install bower -g npm install grunt install
If you want to run the e2e tests also execute
If you want to install example data execute
To display a rough demo start a webserver with
With Docker and Docker Compose
docker-compose build docker-compose up
which will also watch any code changes you make and trigger a reload of your browser when needed.
--port=PORT to these server tasks to start them on a
custom port instead of the default, which is 8081)
Testing out the application
If you want to see Arethusa's source code inside your browser
unminified, set the environmental variable
DEV as in
DEV=1 grunt server.
To set up a completely local environment run
grunt import to import
example data and explore it in a web-browser based file browser at
To build the docs, run
grunt ngdocs and then load them
in the browser at http://localhost:8081/docs/#/api.
This project has received support from the Andrew W. Mellon Foundation and the Institute of Museum and Library Services and the Humboldt Chair of Digital Humanities at Leipzig
Be sure to check out the following Arethusa-related projects: