Príručka pre vývojárov
Overené podľa repozitára dňa 2026-05-07.
Rýchla orientácia
flowchart LR
Code["Kód v src/app"] --> Tests["Testy"]
Tests --> Gates["CI quality gates"]
Gates --> MR["Merge Request"]
MR --> Main["main"]
Kde čo nájsť
| Cesta | Obsah |
src/app/api | route handlery (API + dashboard) |
src/app/services | business logika a integrácie |
src/app/workers | background job spracovanie |
src/app/models | SQLAlchemy modely |
src/app/schemas | Pydantic request/response DTO |
src/app/security | auth, CSRF, token utility |
src/app/observability | logging, metrics, tracing |
tests/* | unit, integration, load testy |
Lokálne prostredie
| Bash |
|---|
| python -m venv .venv
# Linux/macOS: source .venv/bin/activate
# Windows: .venv\Scripts\Activate.ps1
pip install -e ".[dev]"
docker compose up -d postgres redis
alembic upgrade head
uvicorn app.main:app --reload
|
Povinné quality gates
| Bash |
|---|
| ruff check src/ tests/ scripts/
ruff format --check src/ tests/ scripts/
mypy src/app
pytest tests/unit -q
|
CI definícia:
API a kontrakty
- route inventory:
docs/04-api-spec.md - dashboard routy:
src/app/api/dashboard.py - health/metrics:
src/app/api/health.py
Odporúčaný workflow
- Vytvoriť branch (
feature/*, fix/*, refactor/*). - Implementovať zmenu + testy.
- Prejsť lokálne quality gates.
- Otvoriť MR s popisom dopadu a testov.
- Zlúčiť po code review a zelenom CI.
Dokumentácia
- interné docs:
docs/* - docs site (SK/EN):
docs-site/docs/* - systémový audit:
docs/00_system_audit_2026-02-15.md