updating documentaion

This commit is contained in:
lila 2026-03-21 12:10:59 +01:00
parent 1765923cb6
commit 88ad6ff276
3 changed files with 109 additions and 2 deletions

View file

@ -13,13 +13,13 @@ Each phase produces a working, deployable increment. Nothing is built speculativ
- [x] Configure TypeScript project references across packages
- [x] Set up ESLint + Prettier with shared configs in root
- [x] Set up Vitest in `api` and `web` and both packages
- [ ] Scaffold Express app with `GET /api/health`
- [x] Scaffold Express app with `GET /api/health`
- [ ] Scaffold Vite + React app with TanStack Router (single root route)
- [ ] Configure Drizzle ORM + connection to local PostgreSQL
- [ ] Write first migration (empty — just validates the pipeline works)
- [ ] `docker-compose.yml` for local dev: `api`, `web`, `postgres`, `valkey`
- [ ] `.env.example` files for `apps/api` and `apps/web`
- [ ] testing ts config inheritance with tsx --showConfig
- [ ] update decisions.md
---
@ -37,6 +37,7 @@ Each phase produces a working, deployable increment. Nothing is built speculativ
- [ ] Implement `GET /language-pairs` and `GET /terms` endpoints
- [ ] Define Zod response schemas in `packages/shared`
- [ ] Unit tests for `QuizService` (correct POS filtering, never includes the answer)
- [ ] update decisions.md
---
@ -56,6 +57,7 @@ Each phase produces a working, deployable increment. Nothing is built speculativ
- [ ] Frontend: TanStack Router auth guard (redirects unauthenticated users)
- [ ] Frontend: TanStack Query `api.ts` attaches token to every request
- [ ] Unit tests for JWT middleware
- [ ] update decisions.md
---
@ -71,6 +73,7 @@ Each phase produces a working, deployable increment. Nothing is built speculativ
- [ ] `ScoreScreen` component: final score + play-again button
- [ ] TanStack Query integration for `GET /terms`
- [ ] RTL tests for `QuestionCard` and `OptionButton`
- [ ] update decisions.md
---
@ -93,6 +96,7 @@ Each phase produces a working, deployable increment. Nothing is built speculativ
- [ ] Frontend: `/multiplayer/room/:code` — player list, room code display, "Start Game" (host only)
- [ ] Frontend: `ws.ts` singleton WS client with reconnect on drop
- [ ] Frontend: Zustand `gameStore` handles incoming `room:state` events
- [ ] update decisions.md
---
@ -112,6 +116,7 @@ Each phase produces a working, deployable increment. Nothing is built speculativ
- [ ] Frontend: `ScoreBoard` component — live per-player scores after each round
- [ ] Frontend: `GameFinished` screen — winner highlight, final scores, "Play Again" button
- [ ] Unit tests for `GameService` (round evaluation, tie-breaking, timeout auto-advance)
- [ ] update decisions.md
---
@ -126,6 +131,7 @@ Each phase produces a working, deployable increment. Nothing is built speculativ
- [ ] Drizzle migration runs on `api` container start
- [ ] Seed production DB (run `seed.ts` once)
- [ ] Smoke test: login → solo game → create room → multiplayer game end-to-end
- [ ] update decisions.md
---
@ -141,6 +147,7 @@ Not required to ship, but address before real users arrive.
- [ ] Favicon, page titles, Open Graph meta
- [ ] CI/CD pipeline (GitHub Actions → SSH deploy on push to `main`)
- [ ] Database backups (cron → Hetzner Object Storage)
- [ ] update decisions.md
---