Supported for python version 3.10.
The code requires various packages, which are listed in the requirements/ directory. Using virtual enviroments is recommended. To install them all at once, run the following command in the top-level directory of this repository.
pip install -r requirements/common.txtor
pip3 install -r requirements/common.txtDevelopers should replace common.txt with dev.txt.
More documentation is still pending. In the meantime, feel free to open an issue with questions about usage.
Without Docker:
- Install the dependencies (see above)
- Look at the configs in
tests/sample_configs/and copy the config you want to start with to the root directory under the nameconfig.yml - Review the options for allocation at
app/data/README.md - Run
flask runfrom your terminal
With Docker:
- Pending...
- Application entry point is
/run.py - While this may not stay up-to-date, you can view this Figma board to see a visual representation of the intended structure.