# hoangdinhthien/v0-swimming-lms-demo architecture

> Architecture diagram of the GitHub repository hoangdinhthien/v0-swimming-lms-demo, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/hoangdinhthien/v0-swimming-lms-demo
- Repository: https://github.com/hoangdinhthien/v0-swimming-lms-demo

## Overview

##### Project type and purpose
- This is a full-stack, multi-tenant Learning Management System (LMS) built on Next.js 13 (app directory) and deployed on Vercel, with back-end logic exposed as serverless API endpoints under `/api`.
- It supports role-based access control (admin, manager, instructor, student), tenant selection, authentication, and resource data (courses, students, instructors, news, media, etc.).

##### File structure
- Top-level “api” directory: Contains TypeScript files (`*.ts`) for each REST endpoint (courses, students, instructors, login, tenants, etc.) plus utility modules (api-utils, auth-utils, role-utils). These are deployed as serverless functions.
- “app” directory: Next.js 13 route handlers and React server/client components, organized by feature (login, signup, tenant-selection, courses, chat, dashboard by role). Uses file-system routing (page.tsx, layout.tsx, loading.tsx).
- “components” & “hooks” & “utils”: Shared React components (UI primitives, layout, guards, providers), custom React hooks (useTenant, useUserRole, useToast), utility functions.
- Configuration / tooling: `next.config.mjs`, `tsconfig.json`, Tailwind config, PostCSS, Vercel deployment files.
- Documentation under `docs/` for RBA and tenancy patterns.

##### README insights
- Project syncs with v0.dev chat interface, automatically pushes code to this repo, and deploys on Vercel.
- No in-repo database code—data persistence and auth likely provided by external services via the API layer.

a. Main components
- Client (browser/mobile)
- CDN / Edge Network (Vercel)
- Next.js App (React server & client components)
- Serverless API layer (TypeScript functions under `/api`)
- Authentication & Authorization service (e.g. JWT, role-guard)
- Multi-tenant management module
- External Services:
– Database or headless CMS (courses, users, enrollments)
– Storage/Media service
– Notification service (email/SMS)
– Real-time/chat backend (if chat is real-time)
b. Relationships & data flow
- Client → Vercel Edge → Next.js renders pages / hydrates React
- Client/server components call `/api/*` endpoints
- API layer performs auth-guard, tenant check, then reads/writes to external DB or services
- Role-guard in UI layer (components/role-guard.tsx) ensures correct dashboard features
c. Architectural patterns
- File-system routing (Next.js 13 app dir)
- Serverless micro-service endpoints (each API file is its own function)
- Multi-tenant context provided via TenantProvider / client-side hook
- Role-based access control implemented in both API (role-utils.ts) and UI (role-guard.tsx)
- Shared UI primitives and theming (components/ui, theme-provider)
d. Key technologies
- Next.js 13 (app router, server & client components)
- React, TypeScript
- Tailwind CSS
- Vercel (deployment, CDN, edge)
- v0.dev integration (auto-sync & backend services)

##### Essential details to capture
- Multi-tenant context injection path
- Auth & role guard checks at both UI and API boundaries
- File-system routing mapping (page.tsx → URL path)
- Shared component library intake by all pages
- Deployment flow: Git push → V0.dev sync → Vercel build → Edge/CDN

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% User to CDN
    User["User (Browser/Mobile)"]:::external
    CDN["Vercel CDN/Edge"]:::external

    User -->|"HTTP/HTTPS"| CDN

    %% Presentation Layer
    subgraph "Presentation Layer (Next.js App)" 
      direction TB
      RootLayout["Root Layout<br>(app/layout.tsx)"]:::frontend
      GlobalsCSS["Global Styles<br>(app/globals.css)"]:::frontend

      subgraph "Routes"
        direction TB
        TenantSelection["Tenant Selection Page<br>(app/tenant-selection/page.tsx)"]:::frontend
        LoginPage["Login Page<br>(app/login/page.tsx)"]:::frontend
        ChatPage["Chat Page<br>(app/chat/page.tsx)"]:::frontend
        subgraph "Dashboard Pages"
          direction TB
          AdminDash["Admin Dashboard<br>(app/dashboard/admin/page.tsx)"]:::frontend
          ManagerDash["Manager Dashboard<br>(app/dashboard/manager/page.tsx)"]:::frontend
          InstructorDash["Instructor Dashboard<br>(app/dashboard/instructor/page.tsx)"]:::frontend
          StudentDash["Student Dashboard<br>(app/dashboard/student/page.tsx)"]:::frontend
        end
      end

      subgraph "Shared UI Components"
        direction TB
        TenantSelector["Tenant Selector<br>(components/tenant-selector.tsx)"]:::frontend
        TenantProvider["Tenant Provider<br>(components/tenant-provider.tsx)"]:::frontend
        AuthProvider["Auth Provider<br>(components/auth-provider.tsx)"]:::frontend
        RoleGuard["Role Guard<br>(components/role-guard.tsx)"]:::frontend
        DashboardLayout1["Dashboard Layout<br>(components/dashboard-layout.tsx)"]:::frontend
        DashboardLayout2["Dashboard Layout V2<br>(components/dashboard-layout-v2.tsx)"]:::frontend
        UIPrimitives["UI Primitives<br>(components/ui/)"]:::frontend
      end

      subgraph "Hooks & Utils"
        direction TB
        UseTenant["useTenant Hook<br>(hooks/useTenant.ts)"]:::frontend
        UseUserRole["useUserRole Hook<br>(hooks/useUserRole.ts)"]:::frontend
        TenantUtils["Tenant Utils<br>(utils/tenant-utils.ts)"]:::frontend
      end
    end

    %% Connect CDN to Presentation
    CDN -->|"SSR/SSG Request"| RootLayout
    RootLayout --> GlobalsCSS
    RootLayout --> TenantSelection
    RootLayout --> LoginPage
    RootLayout --> ChatPage

    TenantSelection --> TenantProvider
    TenantProvider --> UseTenant
    UseTenant --> TenantUtils

    LoginPage --> AuthProvider
    AuthProvider --> UseUserRole
    AuthProvider --> RoleGuard

    RoleGuard --> AdminDash
    RoleGuard --> ManagerDash
    RoleGuard --> InstructorDash
    RoleGuard --> StudentDash

    AdminDash --> DashboardLayout1
    ManagerDash --> DashboardLayout1
    InstructorDash --> DashboardLayout1
    StudentDash --> DashboardLayout2

    %% Presentation to API calls
    TenantSelection -->|"REST API"| TenantAPI
    LoginPage -->|"REST API"| LoginAPI
    AdminDash -->|"REST API"| CoursesAPI
    ManagerDash -->|"REST API"| StudentsAPI
    InstructorDash -->|"REST API"| InstructorsAPI
    ChatPage -->|"WebSocket"| ChatService
    ChatPage -->|"REST API"| MediaAPI
    AdminDash -->|"REST API"| NewsAPI

    %% Serverless API Layer
    subgraph "Serverless API Layer" 
      direction TB
      CoursesAPI["Courses API<br>(api/courses-api.ts)"]:::api
      StudentsAPI["Students API<br>(api/students-api.ts)"]:::api
      InstructorsAPI["Instructors API<br>(api/instructors-api.ts)"]:::api
      LoginAPI["Login API<br>(api/login-api.ts)"]:::api
      TenantAPI["Tenant API<br>(api/tenant-api.ts)"]:::api
      MediaAPI["Media API<br>(api/media-api.ts)"]:::api
      NewsAPI["News API<br>(api/news-api.ts)"]:::api
      RoleUtils["Role Utils<br>(api/role-utils.ts)"]:::api
      AuthUtils["Auth Utils<br>(api/auth-utils.ts)"]:::api
      APIUtils["API Utils<br>(api/api-utils.ts)"]:::api
    end

    %% API to External Services
    CoursesAPI -->|"SQL"| DB
    StudentsAPI -->|"SQL"| DB
    InstructorsAPI -->|"SQL"| DB
    TenantAPI -->|"SQL"| DB
    MediaAPI -->|"REST"| Storage
    NewsAPI -->|"SQL"| DB
    LoginAPI -->|"JWT"| AuthService
    AuthUtils --> AuthService
    APIUtils --> DB

    %% External Services
    subgraph "External Services" 
      direction TB
      DB["Database<br>(PostgreSQL/RDS)"]:::external
      Storage["Storage/Media Service"]:::external
      Notification["Notification Service<br>(Email/SMS)"]:::external
      ChatService["Real-time Chat Service"]:::external
      AuthService["Auth Service<br>(JWT)"]:::external
    end

    %% Click events
    click RootLayout "https://github.com/hoangdinhthien/v0-swimming-lms-demo/blob/main/app/layout.tsx"
    click GlobalsCSS "https://github.com/hoangdinhthien/v0-swimming-lms-demo/blob/main/app/globals.css"
    click TenantSelection "https://github.com/hoangdinhthien/v0-swimming-lms-demo/blob/main/app/tenant-selection/page.tsx"
    click LoginPage "https://github.com/hoangdinhthien/v0-swimming-lms-demo/blob/main/app/login/page.tsx"
    click ChatPage "https://github.com/hoangdinhthien/v0-swimming-lms-demo/blob/main/app/chat/page.tsx"
    click AdminDash "https://github.com/hoangdinhthien/v0-swimming-lms-demo/blob/main/app/dashboard/admin/page.tsx"
    click ManagerDash "https://github.com/hoangdinhthien/v0-swimming-lms-demo/blob/main/app/dashboard/manager/page.tsx"
    click InstructorDash "https://github.com/hoangdinhthien/v0-swimming-lms-demo/blob/main/app/dashboard/instructor/page.tsx"
    click StudentDash "https://github.com/hoangdinhthien/v0-swimming-lms-demo/blob/main/app/dashboard/student/page.tsx"
    click TenantSelector "https://github.com/hoangdinhthien/v0-swimming-lms-demo/blob/main/components/tenant-selector.tsx"
    click TenantProvider "https://github.com/hoangdinhthien/v0-swimming-lms-demo/blob/main/components/tenant-provider.tsx"
    click AuthProvider "https://github.com/hoangdinhthien/v0-swimming-lms-demo/blob/main/components/auth-provider.tsx"
    click RoleGuard "https://github.com/hoangdinhthien/v0-swimming-lms-demo/blob/main/components/role-guard.tsx"
    click DashboardLayout1 "https://github.com/hoangdinhthien/v0-swimming-lms-demo/blob/main/components/dashboard-layout.tsx"
    click DashboardLayout2 "https://github.com/hoangdinhthien/v0-swimming-lms-demo/blob/main/components/dashboard-layout-v2.tsx"
    click UIPrimitives "https://github.com/hoangdinhthien/v0-swimming-lms-demo/tree/main/components/ui/"
    click UseTenant "https://github.com/hoangdinhthien/v0-swimming-lms-demo/blob/main/hooks/useTenant.ts"
    click UseUserRole "https://github.com/hoangdinhthien/v0-swimming-lms-demo/blob/main/hooks/useUserRole.ts"
    click TenantUtils "https://github.com/hoangdinhthien/v0-swimming-lms-demo/blob/main/utils/tenant-utils.ts"
    click CoursesAPI "https://github.com/hoangdinhthien/v0-swimming-lms-demo/blob/main/api/courses-api.ts"
    click StudentsAPI "https://github.com/hoangdinhthien/v0-swimming-lms-demo/blob/main/api/students-api.ts"
    click InstructorsAPI "https://github.com/hoangdinhthien/v0-swimming-lms-demo/blob/main/api/instructors-api.ts"
    click LoginAPI "https://github.com/hoangdinhthien/v0-swimming-lms-demo/blob/main/api/login-api.ts"
    click TenantAPI "https://github.com/hoangdinhthien/v0-swimming-lms-demo/blob/main/api/tenant-api.ts"
    click MediaAPI "https://github.com/hoangdinhthien/v0-swimming-lms-demo/blob/main/api/media-api.ts"
    click NewsAPI "https://github.com/hoangdinhthien/v0-swimming-lms-demo/blob/main/api/news-api.ts"
    click RoleUtils "https://github.com/hoangdinhthien/v0-swimming-lms-demo/blob/main/api/role-utils.ts"
    click AuthUtils "https://github.com/hoangdinhthien/v0-swimming-lms-demo/blob/main/api/auth-utils.ts"
    click APIUtils "https://github.com/hoangdinhthien/v0-swimming-lms-demo/blob/main/api/api-utils.ts"

    %% Styles
    classDef frontend fill:#E0F2FE,stroke:#0284C7,stroke-width:1px;
    classDef api fill:#D1FAE5,stroke:#059669,stroke-width:1px;
    classDef external fill:#FEF3C7,stroke:#D97706,stroke-width:1px;
```
