nsc-events-fullstack_31_132_add-product-design-document

[NahomAlemu]

Summary & Changes 📃

• Resolves: Feature Request: Create a product design document for NSC Events app #132

• Summary:

  • 🔨 Adds a comprehensive Product Design Document (PDD) - First draft to serve as the canonical reference for the NSC Events platform
  • 👀 Contributors and stakeholders can now understand the full system architecture, features, data model, and technical
    decisions in one place
  • 🗨️ Document covers: technical stack (NestJS/Next.js 14/PostgreSQL), all API endpoints, core features (event discovery,
    creation, registration, authentication), role-based permissions, and identified gaps/technical debt

• Changes:

  • ✅ Added Product-design.md with 9 major sections covering the entire platform
  • ✅ Documented technical architecture (backend, frontend, infrastructure)
  • ✅ Included link to interactive ERD on dbdiagram.io
  • ✅ Defined user roles (Admin, Creator, User) with permissions matrix
  • ✅ Listed all API endpoints organized by domain
  • ✅ Identified feature gaps (notifications, calendar sync, QR check-in, etc.)
  • ✅ Documented technical debt items (JWT storage, migrations, auth)
  • 🛠️ No breaking changes
  • 📝 This is documentation only — no code changes

How to Test 🧪

1. Steps to Reproduce:
   • Step 1: Open Product-design.md in the repository root
   • Step 2: Review the document structure and content
   • Step 3: Verify the ERD link works: https://dbdiagram.io/d/NSC-Events-ERD-696e9c7ad6e030a02480f84a
2. Expected Behavior: Document renders correctly with proper markdown formatting, tables, and links

Checklist ✅

• I have tested this PR locally and it works as expected.
• This PR resolves an issue (Resolves #132).
• Reviewers, assignees(self), tags, and labels are correctly assigned.
• Squash commits and enable auto-merge if approved.

[gitbiruk2010]

The stack and naming looks good and aligns with the project codebase. the only mismatch i see is the doc describes google oauth as federated login in the product-design but the code exposes a google auth flow at google-auth/login and callback that is lableled as google calendar integration, not general sign-in (google-calendar.controller.ts, main.ts). other than that mismatch the rest looks good.

[TVW96]

The stack and naming looks good and aligns with the project codebase. the only mismatch i see is the doc describes google oauth as federated login in the product-design but the code exposes a google auth flow at google-auth/login and callback that is lableled as google calendar integration, not general sign-in (google-calendar.controller.ts, main.ts). other than that mismatch the rest looks good.

It should be fair to say that Google auth is implied through use of google calendar since you can't use the calendar API features without first authenticating into your Google account.

[NahomAlemu]

Since my practicum work has ended, I'm closing this PR to keep the repository tidy. I won't be able to address future feedback, but feel free to use this branch as a reference if the feature is needed later!