define-architecture

Define Architecture

Define workflow, repo shape, and backend/frontend architecture patterns.

Workflow

• Build frontend first: mock UI -> proto contract -> backend (TDD) -> integrate.
• Exception: unblocker infra (auth/middleware/schema) can come first.
• Ship small and reversible changes; rollback faster than you debate.
• Add structure only when customers pay, multiple contributors exist, or bugs cost real money/time.
• Use shipping-practices.md for rollout, flags, and feedback loops.

Stack defaults (adjust per project)

• Turborepo + npm workspaces.
• Next.js App Router + React.
• Tailwind CSS + shadcn/ui.
• React Hook Form + TanStack Query.
• ConnectRPC + protobuf types.
• Prisma + Postgres.
• Supabase (auth/storage), Stripe (payments), Resend (email), Twilio (SMS).
• Ultracite with Biome.
• Vitest.
• Deploy: Vercel (web) + Fly.io (API).

Monorepo shape (example)

• apps/: api, web, admin (adapt names to product domains)
• packages/: shared, ui, icons, auth

Backend module pattern

• Handler: transport only.
• Service: business orchestration.
• DAO: DB access only (class with explicit methods).
• Mapper: DB/Proto/Domain transforms.
• Constants/types: module-level.

DAO rules

• Explicit input/return types.
• Prisma select const pattern for DRY types.
• Audit log all Create/Update/Delete.

Backend request context

• Use AsyncLocalStorage-backed RequestContext.
• Initialise context in every entrypoint (RPC, HTTP, jobs, CLI).
• Access via getContext(); no explicit context params.
• Loggers read context automatically.

ConnectRPC middleware rules

• Define a route policy for every method.
• Use shared middleware for auth, errors, logging, and context.
• No manual auth calls inside handlers.
• No try/catch for business logic; let error middleware handle.
• Use auth helpers (requireUserAuth, requireStaffAuth, requireVenueAccess, getAuthContext).
• Register services via registerServiceWithPolicies.

Frontend architecture

• Server Components by default; "use client" only when needed.
• TanStack/Connect Query for server state; MobX only for global client state.
• Use implement-frontend for forms, hooks, and type safety.
• Use audit-ui for UI polish; use ui-animation for motion rules.

Commands (common)

• npm run dev / npm run dev --workspace=<pkg>
• npm run build, npm run lint, npm run check-types
• npm run test --workspace=<pkg>, npm run test:coverage --workspace=<pkg>
• npm run codegen --workspace=packages/proto
• npm run migrate:dev --workspace=apps/api

Testing

• Backend TDD required: Red -> Green -> Refactor.
• Unit tests: no DB; run in parallel; mock dependencies.
• Integration/E2E: parallel with dynamic IDs.
• Frontend tests: Vitest/jsdom as needed.

Craftsmanship reference

• Use craftsmanship.md for debugging, testing, performance, portability, and professionalism checklists.
• Apply these when setting org-wide standards or reviewing architecture decisions.

Conventions

• Prefer interface over type; use interface extends instead of type & (flat cached types vs recursive merge).
• Use import type for types.
• Biome: 2-space indent, double quotes, semicolons, 100 char width.

Commits and PRs

• Commit subjects in imperative mood.
• PRs: green lint/type/tests, document migrations, add UI screenshots.
• Small teams default to small changes, frequent merges, and a rollback plan. PRs are optional as broadcast, not permission.

Production readiness (priority order)

• Security: rotate secrets, CORS, rate limits, headers, dependency scanning.
• Architecture: modular services, auth/error middleware, strict typing, and conventional/boring stacks.
• Infra: integration tests, health checks, automated deploys.
• Observability: tracing, audit logs, alerting.