1.2 KiB
1.2 KiB
Repository Structure
infra/: Infrastructure and operations (Docker, scripts, deployment).backend/: FastAPI backend.apps/: Flutter mobile app.docs/: Documentation and design/planning artifacts.
Rules Hierarchy
- This root
AGENTS.mddefines global rules and applies to all changes. - When editing
backend/, you must also followbackend/AGENTS.md. - When editing
apps/, you must also followapps/AGENTS.md.
Docker Startup
Always start services with the env file:
docker compose --env-file .env -f infra/docker/docker-compose.yml up -d
Git Branch and Worktree Policy
- Use
devas the default base branch for day-to-day development. - New development worktrees must be created from
dev(never frommain). - Do not develop or commit directly on
mainoutside explicit release/merge workflows. - Do not rewrite
mainhistory unless explicitly requested (including reset and force push).
API Route Documentation
When modifying HTTP routes (adding, updating, or removing endpoints):
- Sync changes to
docs/runtime/runtime-route.md - Include: HTTP method, path, request/response schema, status codes, error format
- Keep documentation in sync with actual implementation