You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update backend documentation to reflect the new TypeScript + Prisma architecture, dependency upgrades, and testing/deployment workflows. Ensure onboarding and maintenance docs accurately describe the current system.
Tasks
Update README.md (backend-specific or root as appropriate) to cover:
- Tech stack (TypeScript, Prisma, Apollo, Express, MongoDB)
- Project structure (app/, app/types/, app/data/, etc.)
- Development workflow (pnpm dev, pnpm test, pnpm build)
7.67 Update Backend Documentation
Summary
Update backend documentation to reflect the new TypeScript + Prisma architecture, dependency upgrades, and testing/deployment workflows. Ensure onboarding and maintenance docs accurately describe the current system.
Tasks
README.md(backend-specific or root as appropriate) to cover:- Tech stack (TypeScript, Prisma, Apollo, Express, MongoDB)
- Project structure (
app/,app/types/,app/data/, etc.)- Development workflow (
pnpm dev,pnpm test,pnpm build)/docs:- Architecture overview (data flow, GraphQL, Prisma, server)
- TypeScript conventions and strict-mode expectations
- Database layer (Prisma schema, migrations)
- Testing strategy (unit, integration, subscriptions)
- Mongoose → Prisma transition
- Babel → TypeScript toolchain transition
- Major dependency upgrades
- Babel-based builds
- Mongoose as primary ORM
- Deprecated packages or APIs
Expected Behavior
Documentation provides accurate guidance for running, developing, testing, and deploying the backend with the current stack and conventions.
Tech Notes
Acceptance Criteria
Test Instructions
pnpm dev,pnpm test, andpnpm buildfollowing the docs.