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:
- browse digitized page images,
- search and select the texts of these digitized books,
- annotate text or illustrations in these works, and then
- publish digital copies of the texts with their annotations. Administrators can organize digitized books into collections, facilitating user access to digitized books available through the platform. Since its release, Readux has proved to be an innovative research and pedagogy tool for scholars and faculty at Emory University and beyond, with an array of use-cases ranging from teaching to publishing.
- Python 3
Set up development environment
- Clone this repository.
- Navigate to the readux directory.
- Create virtual environment and activate it.
python3 -m venv venv source venv/bin/activate
- Install the dependencies.
pip install -r requirements/local.txt bundle install
- Copy and set up your local settings.
cp config/settings/local.dst config/settings/local.py
- Add your database settings to the local.py file or set an environment variable. For example:
export DATABASE_URL=postgres://<database user>:<database password>@127.0.0.1:5432/<database name>
- Run the migrations and load the example data.
python manage.py migrate python manage.py loaddata apps/fixtures/dump.json
Running local development server
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
Running the tests
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.
We use the Git-Flow branching model. Please submit pull requests against the develop branch.
Code of conduct
??? 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
When importing with Import-Export
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.