backend-python

FastAPI + SQLModel scaffold for the backend rewrite.

1) Create and activate virtual environment

python3 -m venv .venv
source .venv/bin/activate

2) Install dependencies

pip install -e .
pip install -e .[dev]

3) Configure environment

cp config.yaml.example config.yaml

4) Run development server

python -m app.main

• default config path: ./config.yaml
• frontend assume backend serving port 3000, adjust as needed

Use a custom YAML config file:

python -m app.main --config ./config.example.yaml

5) Run tests

pytest -q

Project layout

• app/main.py: FastAPI app entry and startup lifecycle
• app/core/config.py: central settings
• app/db/session.py: SQLModel engine and session dependency
• app/models/: SQLModel table models
• app/crud/: data access functions
• app/api/v1/endpoints/: API endpoint modules