# pradumn88/lms-college-site architecture

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

- Interactive diagram: https://gitdiagram.com/pradumn88/lms-college-site
- Repository: https://github.com/pradumn88/lms-college-site

## Overview

##### Project Type & Purpose
- This is a full-stack college LMS (Learning Management System).
- Frontend: React/Vite single-page app with separate Educator and Student views.
- Backend: Node.js/Express REST API.
- Persistence & Services: MongoDB for data, Cloudinary for media, Stripe (via webhooks) for payments.

##### Main Components
a. User Clients (Student & Educator browsers/mobile)
b. Frontend Application
- Vite-powered React SPA
- Context layer (AppContext.jsx)
- Components directory (UI widgets)
- Pages directory (route targets)
c. Backend Application
- Express server (server/server.js)
- Routes layer (userRoutes, courseRoutes, educatorRoutes, webhook)
- Controllers (handle request logic)
- Middlewares (authMiddleware)
- Models (Mongoose schemas: User, Course, Purchase, CourseProgress)
- Configs (MongoDB, Cloudinary, multer)
d. Datastore & External Services
- MongoDB Atlas
- Cloudinary (media upload)
- Stripe (payment + webhooks)
e. Deployment / Hosting
- Vercel (Client)
- Vercel or Node host (Server)

##### Relationships & Data Flows
- User → Frontend: HTTP (browser loads index.html, then API calls via fetch/axios).
- Frontend → Backend: REST API over HTTPS:
– Authentication endpoints (login/signup) → authMiddleware → userController
– Course management (CRUD) → courseController
– Educator endpoints → educatorController
– Webhooks (Stripe) → webhooks.js
- Backend → MongoDB: Mongoose queries for User, Course, Purchase, Progress
- Backend → Cloudinary: media uploads via cloudinary.js + multer middleware
- Backend ↔ Stripe: webhooks for payment fulfillment

##### Architectural Patterns & Principles
- Separation of concerns (Presentation vs. Business Logic vs. Data Access)
- MVC-style layering in the backend (Models, Controllers, Routes)
- Component-based UI in the frontend (React)
- Context API for global state management
- Middleware for cross-cutting concerns (auth, file-upload)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Tier 1: Clients
    Student["Student"]:::external
    Educator["Educator"]:::external

    %% Tier 2: Frontend SPA
    subgraph "Frontend: React/Vite SPA"
        direction TB
        HTML["index.html"]:::frontend
        Entry["main.jsx"]:::frontend
        ViteConfig["vite.config.js"]:::frontend
        VercelFront["vercel.json"]:::frontend
        Styles1["index.css"]:::frontend
        Styles2["App.css"]:::frontend
        Context["AppContext.jsx"]:::frontend
        subgraph "Pages"
            direction TB
            PagesEdu["Educator Pages"]:::frontend
            PagesStu["Student Pages"]:::frontend
        end
        subgraph "Components"
            direction TB
            CompEdu["Educator Components"]:::frontend
            CompStu["Student Components"]:::frontend
        end
        Student --> HTML
        Educator --> HTML
        HTML --> Entry
        Entry --> Context
        Context --> PagesEdu
        Context --> PagesStu
        Context --> CompEdu
        Context --> CompStu
        Entry --> Styles1
        Entry --> Styles2
        Entry --> ViteConfig
        Entry --> VercelFront
    end

    %% Tier 3: Backend API
    subgraph "Backend: Node.js/Express API"
        direction TB
        Server["server.js"]:::backend

        subgraph "Routes"
            direction TB
            UserRoutes["userRoutes.js"]:::backend
            CourseRoutes["courseRoutes.js"]:::backend
            EducatorRoutes["educatorRoutes.js"]:::backend
        end

        subgraph "Controllers"
            direction TB
            UserCtrl["userController.js"]:::backend
            CourseCtrl["courseController.js"]:::backend
            EducatorCtrl["educatorController.js"]:::backend
            WebhooksCtrl["webhooks.js"]:::backend
        end

        subgraph "Middleware"
            direction TB
            AuthMW["authMiddleware.js"]:::backend
        end

        subgraph "Models"
            direction TB
            UserModel["user.js"]:::backend
            CourseModel["course.js"]:::backend
            PurchaseModel["Purchase.js"]:::backend
            ProgressModel["CourseProgress.js"]:::backend
        end

        subgraph "Configs"
            direction TB
            MongoCfg["mongodb.js"]:::backend
            CloudCfg["cloudinary.js"]:::backend
            MulterCfg["multer.js"]:::backend
            VercelBack["vercel.json"]:::backend
        end

        Entry -->|calls API| Server
        Server --> UserRoutes
        Server --> CourseRoutes
        Server --> EducatorRoutes
        Server --> WebhooksCtrl
        UserRoutes --> AuthMW
        CourseRoutes --> AuthMW
        EducatorRoutes --> AuthMW
        UserRoutes --> UserCtrl
        CourseRoutes --> CourseCtrl
        EducatorRoutes --> EducatorCtrl
        WebhooksCtrl --> CourseCtrl
        UserCtrl --> UserModel
        CourseCtrl --> CourseModel
        CourseCtrl --> PurchaseModel
        CourseCtrl --> ProgressModel
        WebhooksCtrl --> PurchaseModel
        Server --> MongoCfg
        Server --> CloudCfg
        Server --> MulterCfg
        VercelBack --> Server
    end

    %% Tier 4: Data & External Services
    subgraph "Data & External Services"
        direction TB
        MongoDB["MongoDB Atlas"]:::database
        Cloudinary["Cloudinary"]:::external
        Stripe["Stripe"]:::external
    end

    CourseCtrl -->|reads/writes| MongoDB
    UserCtrl -->|reads/writes| MongoDB
    PurchaseModel -->|writes| MongoDB
    ProgressModel -->|writes| MongoDB
    CourseCtrl -->|uploads media| Cloudinary
    WebhooksCtrl -->|listens events| Stripe

    %% Click Events
    click HTML "https://github.com/pradumn88/lms-college-site/blob/main/Client/index.html"
    click Entry "https://github.com/pradumn88/lms-college-site/blob/main/Client/src/main.jsx"
    click ViteConfig "https://github.com/pradumn88/lms-college-site/blob/main/Client/vite.config.js"
    click VercelFront "https://github.com/pradumn88/lms-college-site/blob/main/Client/vercel.json"
    click Styles1 "https://github.com/pradumn88/lms-college-site/blob/main/Client/src/index.css"
    click Styles2 "https://github.com/pradumn88/lms-college-site/blob/main/Client/src/App.css"
    click Context "https://github.com/pradumn88/lms-college-site/blob/main/Client/src/Context/AppContext.jsx"
    click CompEdu "https://github.com/pradumn88/lms-college-site/tree/main/Client/src/Components/Educator/"
    click CompStu "https://github.com/pradumn88/lms-college-site/tree/main/Client/src/Components/Student/"
    click PagesEdu "https://github.com/pradumn88/lms-college-site/tree/main/Client/src/Pages/Educator/"
    click PagesStu "https://github.com/pradumn88/lms-college-site/tree/main/Client/src/Pages/Student/"
    click Server "https://github.com/pradumn88/lms-college-site/blob/main/server/server.js"
    click UserRoutes "https://github.com/pradumn88/lms-college-site/blob/main/server/routes/userRoutes.js"
    click CourseRoutes "https://github.com/pradumn88/lms-college-site/blob/main/server/routes/courseRoutes.js"
    click EducatorRoutes "https://github.com/pradumn88/lms-college-site/blob/main/server/routes/educatorRoutes.js"
    click UserCtrl "https://github.com/pradumn88/lms-college-site/blob/main/server/controllers/userController.js"
    click CourseCtrl "https://github.com/pradumn88/lms-college-site/blob/main/server/controllers/courseController.js"
    click EducatorCtrl "https://github.com/pradumn88/lms-college-site/blob/main/server/controllers/educatorController.js"
    click WebhooksCtrl "https://github.com/pradumn88/lms-college-site/blob/main/server/controllers/webhooks.js"
    click AuthMW "https://github.com/pradumn88/lms-college-site/blob/main/server/middlewares/authMiddleware.js"
    click UserModel "https://github.com/pradumn88/lms-college-site/blob/main/server/models/user.js"
    click CourseModel "https://github.com/pradumn88/lms-college-site/blob/main/server/models/course.js"
    click PurchaseModel "https://github.com/pradumn88/lms-college-site/blob/main/server/models/Purchase.js"
    click ProgressModel "https://github.com/pradumn88/lms-college-site/blob/main/server/models/CourseProgress.js"
    click MongoCfg "https://github.com/pradumn88/lms-college-site/blob/main/server/configs/mongodb.js"
    click CloudCfg "https://github.com/pradumn88/lms-college-site/blob/main/server/configs/cloudinary.js"
    click MulterCfg "https://github.com/pradumn88/lms-college-site/blob/main/server/configs/multer.js"
    click VercelBack "https://github.com/pradumn88/lms-college-site/blob/main/server/vercel.json"

    %% Styles
    classDef frontend fill:#E0F7FA,stroke:#00796B
    classDef backend fill:#E8F5E9,stroke:#388E3C
    classDef database fill:#FFF3E0,stroke:#FB8C00
    classDef external fill:#F3E5F5,stroke:#6A1B9A
```
