Readux is a platform developed by the Emory Center for Digital Scholarship which allows users to read, take notes on, and publish with digitized texts from libraries’ archival collections. With Readux, users are able to:
python3 -m venv venv source venv/bin/activate
pip install -r requirements/local.txt bundle install
cp config/settings/local.dst config/settings/local.py
export DATABASE_URL=postgres://<database user>:<database password>@127.0.0.1:5432/<database name>
python manage.py migrate python manage.py loaddata apps/fixtures/dump.json
Run the development under https to avoid mix content errors. Note: this will generate a self-signed certificate. There are ways to tell your browser to trust these certs, but that is beyond the scope of this README.
python manage.py runserver_plus --cert-file cert.crt 0.0.0.0:3000
Readux uses Django's default test framework, but is configured to use pytest.
Your database user will need to be able to create a database:
alter user readux createdb;
To run the tests, simply run:
Readux is configured to use Travis CI. Any push will trigger build.
fab deploy:branch=develop -H readux.ecdsdev.org
For public alpha:
fab deploy:branch=master -H readux2.ecdsdev.org
Note: if no branch is passed, the deploy will default to master.
We use the Git-Flow branching model. Please submit pull requests against the develop branch.
??? for exporting.
This software is distributed under the Apache 2.0 License.
Use the fork of Wagtail Autocomplete because of UUID. https://github.com/jcmundy/wagtail-autocomplete
Import Collections, then Manifests, then I Servers, then Canvases. Annotations will populate based on Canvases.
When importing collections, images for the "Original" field must already be in the apps/media/originals/ folder. List
originals/filename.jpg in the column for original.