The backend hosts the documentation and an api to push documentation and tag versions of the documentation.
You will need to install poetry pip install poetry==1.7.1
.
Install the dependencies and run the application:
# install dependencies
poetry install
# run the app
[DOCAT_SERVE_FILES=1] [FLASK_DEBUG=1] [PORT=8888] poetry run python -m docat
- DOCAT_SERVE_FILES: Serve static documentation instead of a nginx (for testing)
- DOCAT_STORAGE_PATH: Upload directory for static files (needs to match nginx config)
- FLASK_DEBUG: Start flask in debug mode