Skip to content

feat: T001 backend documentation and T002 NestJS project setup#2

Open
zainrikaz21-prog wants to merge 2 commits into
developfrom
feature/T001-T002-backend-setup
Open

feat: T001 backend documentation and T002 NestJS project setup#2
zainrikaz21-prog wants to merge 2 commits into
developfrom
feature/T001-T002-backend-setup

Conversation

@zainrikaz21-prog

Copy link
Copy Markdown
Collaborator

Summary

This PR covers the completion of T001 and T002 for the backend team.

T002 — Backend Project Initialisation

  • Initialised NestJS project inside the monorepo under /backend
  • Installed all necessary packages:
    • @nestjs/prisma, prisma, pg (database)
    • @nestjs/jwt, @nestjs/passport, passport-jwt (authentication)
    • bcryptjs, cookie-parser (security)
    • @nestjs/config, class-validator, class-transformer (validation)
  • Confirmed server runs successfully on http://localhost:3000

T001 — Backend Framework Documentation

  • Created docs/BACKEND.md under the /docs directory
  • Documentation covers:
    • Technology stack with reasons
    • Why NestJS over Express
    • Layered architecture explanation
    • Row Version concept
    • Authentication flow with HTTP-only cookies
    • API conventions and pagination
    • Environment variables
    • How to set up and run
    • Git workflow and branch naming

Notes

  • Prisma selected as ORM instead of TypeORM
  • Monorepo structure confirmed — backend lives under /backend
  • Branch naming follows feature/- convention

Checklist

  • Project initialised and running
  • All packages installed
  • Documentation written and saved to /docs/BACKEND.md
  • Tested server runs successfully

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant