Installation

Create conda environment:

$ conda create --name dossier python==3.8.12

Activate the environment:

$ source activate dossier

Use pip to install requirements:

(dossier) $ pip install -r requirements.txt

ElasticSearch configuration

Connection parameters to the ElasticSearch database should be stored in src/dossier_search/utils/config.ini file containing three params: cloud_id, userand password.

Running

Make migrations and migrate the database

(dossier) $ python manage.py makemigrations engine
(dossier) $ python manage.py migrate

Finally, run Django server

(dossier) $ python manage.py runserver 8000

Server should be available at http://127.0.0.1:8000/

Contributing

Code style

Make sure to run the following commands to format your code:

(dossier) $ make style
(dossier) $ make quality

This runs the black formatter, isort, and lints to ensure that the code is readable and looks nice. Flake8 linting errors may require manual changes.