Skip to content

alexandermendes/explicates

Repository files navigation

Explicates

Build Status Coverage Status

A PostgreSQL-backed Web Annotation server.

Read the documentation

Setup

A virtual machine setup is provided for local development.

Download and install Vagrant >= 4.2.10 and VirtualBox >= 1.2.1, then run:

# setup vm
vagrant up

# enter vm
vagrant ssh

# run
python run.py

The server should now be available at http://127.0.0.1:3000.

Configuration

See settings.py.tmpl for all available configuration settings. To change any settings make a copy of the template:

cp settings.py.tmpl settings.py

Testing

Explicates is tested against Python 2.7 and 3.4:

# python 2
nosetests test/

# python 3
python3 -m "nose"