Repository navigation
Reading Paths
Pick the path that matches what you want to do. Each one is ordered, and you can stop as soon as you have what you need.
Only here to use TTS? Open the planner or the FAQ. You do not need any of this.
Legend: 🚧 means the dedicated wiki page is not written yet; a temporary link to the code or an existing repo doc is given instead.
Goal: run the project locally and land a first pull request. Allow about half a day.
- What is TTS — the problem and the shape of the system.
- Quick start — clone, database, seed, run both servers.
-
CONTRIBUTING.md — branch
from the milestone branch, never PR
main, commits, PR size, code standards. -
Glossary —
coursevscourse unitvsoccurrencevsclass. Read it before your first issue or review; it prevents most misunderstandings. - Architecture overview 🚧 — for now, the project map and the layer summary under it.
- Pick a
good first issue.
Issues are assigned by the project manager. Comment on the issue or ask in the team channel — do not self-assign.
Goal: ship or change an endpoint. Start with a T1 (read-only) issue.
- Glossary — the entities you will query.
- API design doc — what each endpoint does, its auth, and its request/response shapes. The status-checked catalog is 🚧.
- Tech stack — why Bun, Elysia, Prisma 8, and how the client is used.
- Backend layers 🚧 — the dependency rule and where new code belongs. Until it is written, read the
comments at the top of
apps/backend/src/interface/routes/courses.routes.ts. - Request lifecycle 🚧 — middleware → route → use-case → domain → repository → error handler.
- Database guide — the Prisma 8 contract, migrations, backfills and recovery.
- Error handling 🚧 —
HttpError, stable error codes, 400 vs 422. Until then, readapps/backend/src/interface/errors/andmiddleware/error-handler.ts. - Testing 🚧 —
bun:test, fake repositories,createApp().handle(request). Until then, readapps/backend/tests/interface/routes/and itssupport/helpers. - Adding an endpoint 🚧 — the full checklist.
Interim shortcut: read one route file end to end (courses.routes.ts) together with its test
(tests/interface/routes/catalog/courses.test.ts). That pair is the reference implementation.
Goal: change the planner or a page.
- Glossary — especially option, course option, picked course, occurrence.
-
Frontend source — browse
pages/,components/,contexts/,hooks/,api/. - Directory tour 🚧 — what lives where. Interim: the old wiki's
File-Structureis stale; do not follow it. - State & contexts 🚧 — the context map and the
localStorage/ backend split. - Data fetching 🚧 — SWR + Eden Treaty, caching and errors.
- Planner 🚧 — options, conflicts, locks, teacher filters.
- Exchange 🚧 — the exchange flow end to end.
- Styling 🚧 — Tailwind v4,
cn(), Radix/Headless UI.
Interim shortcut: contexts/CombinedProvider.tsx lists every provider; components/planner/
contains the planner itself.
Goal: deploy, debug or change CI.
- README — environment variables and Docker.
- Environments 🚧 — local, dev, staging, production and their URLs.
- CI workflows — typecheck, tests, lint, sigarra SDK drift, deploy.
- Deployment 🚧 — Docker images, the Niployments
/apimount, nginx. - Monitoring 🚧 — Sentry (tunnelled through
/feedback), analytics. - Runbooks 🚧 — rollback, database restore, secret rotation.
Interim shortcut: Dockerfile, docker-compose.yaml, apps/backend/.env.schema,
apps/frontend/.env.schema and .github/workflows/ together describe the whole deployment.
Goal: review a PR or triage an issue.
- CONTRIBUTING.md — the rules being enforced.
- What is TTS — scope: does the change belong in TTS at all?
- API design doc — does the endpoint match the contract, including error codes?
-
Glossary — are the names right? Reject
MajorforCourse,course_unit_idforoccurrenceId, and similar legacy leaks. - PR template.
- Bug or idea: open an issue.
- Assignment or scope: ask the project manager or a coordinator.
-
SIGARRA SDK:
packages/sigarra/README.md. - Something missing from the wiki: the page plan is tracked in #931.
Last verified: 2026-10-27 · source: docs/wiki/00-orientation/reading-paths.md