README.md

juggle

List of services:

• Dev server: https://juggle.kyleobrien.online/

Documentation:

• Architecture overview
• Backend: Routine tasks
• Backend: Pre-commit hook

API documentation:

• ReDoc web UI: https://juggle.kyleobrien.online/_platform/docs/v1/redoc/
• Swagger web UI: https://juggle.kyleobrien.online/_platform/docs/v1/swagger/
• Swagger JSON: https://juggle.kyleobrien.online/_platform/docs/v1/swagger.json
• Swagger YAML: https://juggle.kyleobrien.online/_platform/docs/v1/swagger.yaml

First run:

Install Python 3.9.5 & setup virtual environment. We recommend to use pyenv & pyenv-virtualenv:

pyenv install 3.9.5
pyenv virtualenv 3.9.5 juggle
pyenv activate juggle

Update pip & setuptools, install fabric, invoke & pip-tools:

pip install -U fabric invoke pip pip-tools setuptools

Install Python requirements:

fab pip.sync

Copy initial settings for Django project:

cp ./api/.env.example ./api/.env

Generate SECRET_KEY:

./api/manage.py generate_secret_key

and write it to ./api/.env:

JUGGLE_SECRET_KEY=<your-generated-key>

Run backing services (require Docker):

fab compose.up -d

Run migrations:

./api/manage.py migrate

Run Django server:

fab run