22 lines
938 B
Markdown
22 lines
938 B
Markdown
# Repository guide
|
|
|
|
Magent combines a FastAPI backend, Next.js frontend and SQLite database. Read
|
|
`CONTRIBUTING.md` before changing code and `docs/INSTALLATION.md` before changing
|
|
deployment behavior.
|
|
|
|
## Important paths
|
|
|
|
- `backend/app/`: API, integrations, setup, persistence and background work.
|
|
- `frontend/app/`: application routes and interface components.
|
|
- `backend/tests/` and frontend `*.test.*`: synthetic regression coverage.
|
|
- `compose.yml`: public prebuilt-image deployment.
|
|
- `Dockerfile`: pinned multi-stage production build.
|
|
|
|
## Working rules
|
|
|
|
- Never read, commit or print real `.env`, database, backup or credential data.
|
|
- Keep SQLite to one backend worker and one writable application instance.
|
|
- Preserve origin checks, CSP nonces, non-root execution and persistent key/data paths.
|
|
- Add regression tests and run the checks in `CONTRIBUTING.md`.
|
|
- Use synthetic fixtures; do not call live media services from tests.
|