jacobh2
4fa93c4985
There was no README at the root, and the backend's own still pointed at an onboarding guide that had been deleted. The new one says what the app is, how to run it, and where the code lives, and states the test gates as they actually are rather than as an older note claimed. It records the two things that waste a newcomer's afternoon: the dev server answers on localhost but not on the loopback address, because Vite binds IPv6 first, and the two design documents are largely superseded and say so inline.
58 lines
2.3 KiB
Markdown
58 lines
2.3 KiB
Markdown
# Backend — Föräldraledigplannerare
|
|
|
|
FastAPI + Python 3.14, packages managed with `uv`. Layered architecture
|
|
(entities → repositories → services → routers) with dependency injection so the
|
|
database backend (SQLite now, Postgres later) is swappable.
|
|
|
|
## Setup
|
|
|
|
```bash
|
|
uv sync # install deps (incl. dev group)
|
|
uv run uvicorn app.main:app --reload # run dev server on :8000
|
|
uv run pytest # run tests with coverage
|
|
uv run ruff check . # lint
|
|
```
|
|
|
|
## Layout
|
|
|
|
```
|
|
app/
|
|
config.py # pydantic-settings (app config + frozen LeaveRules)
|
|
dependencies.py # DI factories (pick repo impl by settings.database_type)
|
|
entities/ # plain dataclasses (domain)
|
|
models/ # pydantic API schemas
|
|
repositories/ # abstract interfaces
|
|
repositories_impl/ # concrete impls per backend (sqlite/, postgres/)
|
|
services/ # business logic
|
|
routers/ # FastAPI routes
|
|
db/connection.py # connection + (dev) schema bootstrap
|
|
utils/ # errors, logger
|
|
```
|
|
|
|
## Demo data (manual/browser testing)
|
|
|
|
`scripts/seed_demo.py` seeds a realistic, ready-to-explore workspace through the
|
|
normal service/repository layers (no raw SQL) — a couple workspace with a
|
|
partner, a child born ~6 months ago, vacation rows for only some years (so the
|
|
`is_assumed` badge is visible), day overrides, and a spread of leave wishes
|
|
(fixed, flexible, and one deliberately underfunded to show a shortfall +
|
|
remedies + surplus advice). Login credentials are fixed and printed at the end.
|
|
|
|
```bash
|
|
uv run python scripts/seed_demo.py # create once; re-running is a no-op
|
|
uv run python scripts/seed_demo.py --reset # wipe the demo workspace and rebuild
|
|
```
|
|
|
|
Then open `http://localhost:5173` and log in with the printed `demo@example.com`
|
|
credentials. Safe to re-run: without `--reset` it detects the existing demo
|
|
user and changes nothing; `--reset` only ever deletes the one demo workspace.
|
|
|
|
## Reference vertical slice
|
|
|
|
`VacationDays` is implemented end-to-end (entity → schema → repo interface →
|
|
SQLite impl → service → router → tests). **Copy this slice** when adding a new
|
|
entity.
|
|
|
|
> The inline schema in `db/connection.py` exists only so dev/tests are
|
|
> self-contained. Production schema is owned by Alembic migrations (a senior task).
|