1# Acme API Server
2
3> TypeScript + Express REST API with PostgreSQL.
4> Deployed on AWS ECS. Monorepo managed with Turborepo.
5
6## Code Style
7
8- TypeScript strict mode — no `any`, no `ts-ignore`
9- Named exports only (no default exports)
10- Prefer functional patterns: map/filter/reduce over for-loops
11- Error handling: use Result<T, E> type from `src/lib/result.ts`
12- Use `import type` for type-only imports
13
14## Architecture
15
16- `src/routes/`  — Express route handlers (thin layer, delegates to services)
17- `src/services/` — Business logic, one file per domain entity
18- `src/db/`       — Drizzle ORM schema and query helpers
19- `src/lib/`      — Shared utilities (logger, result type, validation)
20- `src/middleware/` — Express middleware (auth, rate-limiting, error handler)
21
22## Commands
23
24```bash
25pnpm install          # Install dependencies
26pnpm dev              # Start dev server (port 3000)
27pnpm test             # Run Vitest suite
28pnpm test:e2e         # Run Playwright API tests
29pnpm lint             # ESLint + Prettier check
30pnpm db:migrate       # Run pending Drizzle migrations
31pnpm db:seed          # Seed dev database
32```
33
34## Git Conventions
35
36- Conventional Commits: `feat:`, `fix:`, `chore:`, `docs:`
37- Branch naming: `feat/short-description`, `fix/issue-number`
38- Squash merge to main; delete branches after merge
39- Run `pnpm lint && pnpm test` before committing
40
41## Notes
42
43- The `src/legacy/` directory is being migrated to the new service pattern.
44  Do not add new code there. If you need to modify legacy code, migrate
45  the relevant module to `src/services/` first.
46- All dates are stored as UTC in the database. Never use local time.
47- The auth middleware at `src/middleware/auth.ts` uses JWT tokens.
48  Never bypass auth checks — always use the `requireAuth` middleware.
49
50@docs/api-patterns.md
51@docs/database-conventions.md