How areid987/quality-neighbor-monorepo works
Project Type and Purpose
• This is a full-stack monorepo (Turborepo) housing multiple Next.js apps (“qn-dashboard”, “qn-platform”, “qn-business”) and a backend API (“qn-api”), plus shared packages (UI, types, auth, database, config).
• Purpose:
• qn-dashboard: internal team operations
• qn-platform: resident-facing web platform
• qn-business: business owner portal
• qn-api: shared backend services (auth, data, email, file storage)
High-Level File Structure
• apps/
• qn-dashboard, qn-platform, qn-business, qn-api
• packages/
• @qn/ui, @qn/types, @qn/auth, @qn/database, @qn/config
• Quality-Neighbor-Docs/ (detailed docs)
• supabase/ (local Supabase config & migrations)
• scripts/ (deploy/test scripts)
• root config: pnpm-workspace.yaml, turbo.json, tsconfig.json
Key Architectural Insights from README
• Shared UI components (Radix+Tailwind) and TS types enforce consistency.
• Backend: Node.js + Express planned, PostgreSQL (via Supabase) + JWT RBAC, Stripe Identity, SendGrid/Mailgun.
• Frontend apps use Next.js 13 App Router, React, TS, Tailwind CSS.
• CI/CD via GitHub Actions; deployments to Vercel/Netlify (frontend) and AWS/GCP (API, DB).
a. Main Components
• Developer Environment & Monorepo (Turborepo + PNPM)
• Shared Packages Layer (@qn/ui, @qn/types, @qn/auth, @qn/database, @qn/config)
• Frontend Apps: qn-dashboard, qn-platform, qn-business (Next.js apps)
• Backend API: qn-api (Express/Next.js API routes)
• Database: PostgreSQL (hosted/Supabase)
• External Services: Stripe Identity, SendGrid/Mailgun, File Storage (S3/GCS)
b. Relationships & Interactions
• Frontend apps import shared packages at build time.
• Frontends make HTTP/GraphQL calls to the qn-api.
• qn-api uses @qn/database for migrations/client, @qn/auth for JWT/RBAC.
• qn-api reads/writes to PostgreSQL (Supabase), invokes external services (Stripe, Email, Storage).
• CI/CD pipeline triggers builds of apps and packages; deployment scripts push to hosting.
c. Architectural Patterns & Principles
• Monorepo with Turborepo: code sharing and atomic changes.
• Modular packages: single responsibility, shareable code.
• “Separation of Concerns”: distinct frontends vs backend services.
• Scalable micro-service style: each app can be deployed independently.
• App Router pattern in Next.js for server-side logic in frontend.
d. Technologies & Frameworks
• Frontend: Next.js 13, React, TypeScript, Tailwind CSS, Radix UI
• Backend: Node.js, Express.js (or Next.js API routes), JWT, Role-based access
• Database: PostgreSQL (Supabase), migrations via @qn/database
• Auth: JWT, Stripe Identity via @qn/auth
• CI/CD: GitHub Actions, Turborepo, PNPM workspaces
• Hosting: Vercel/Netlify (frontend), AWS/GCP (API & DB), S3/GCS for assets