- python > 3.11
- pyenv (Optional)
- nvm (Optional)
- Docker (Optional)
-
Create/activate virtualenv:
pyenv activate venv
-
pip install -r requirements.txt
- Start the database docker containers:
docker compose up -d
- (Optional) From the backend folder, initialize database and run migrations:
aerich init -t src.database.config.TORTOISE_ORM
aerich init-db
aerich migrate
aerich upgrade
- Start the API server:
python main.py
- Start the Vue server:
npm run dev (local)
npm run dev -- --host (exposed)
-
Navigate to
http://<ip>:5173
for the VueJS frontend -
Navigate to
http://<ip>:8000/docs
for the FastAPI application docs page