# manhquymqy/student-forum-web architecture

> Architecture diagram of the GitHub repository manhquymqy/student-forum-web, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-29). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/manhquymqy/student-forum-web
- Repository: https://github.com/manhquymqy/student-forum-web

## Overview

##### Project Type and Purpose
- This is a full-stack web application (“Diễn Đàn Sinh Viên”):
- Frontend: React single-page app
- Backend: Node.js + Express REST API
- Database: MongoDB
- Purpose: A student discussion forum with authentication (JWT), user roles (admin/student), CRUD operations on forums, posts, comments, plus real-time DB status indicators.

##### File Structure
- Top-level dirs:
- backend/
– config/db.js (DB connection)
– models/ (Mongoose schemas: Student, Forum, Post, Comment)
– controllers/ (MVC controllers: auth, admin, forum, post, comment, status)
– routes/ (Express routers & sub-routers under /api)
– middleware/ (authMiddleware, errorMiddleware)
– scripts/ (createAdmin, resetAdminPassword)
– server.js (Express app entry point)
- frontend/
– public/ (static HTML, manifest, images)
– src/
· components/ (UI pieces, route guards, modals, loader, navbar)
· pages/ (React Router-driven views)
· context/ & contexts/ (React Context providers for DB and Auth)
· services/apiService.js (HTTP client to backend)
· config.js (.env variable for API_URL)
- Config files: .env templates, package.json, vercel.json (backend deploy), README.md

##### README for Additional Insights
- Describes tech stack (Node/Express, React, MongoDB)
- Outlines environment variables (PORT, MONGO_URI, JWT_SECRET, REACT_APP_API_URL)
- Describes startup steps, admin script, key features

## Diagram (Mermaid)

```mermaid
graph TB
    %% External Users and Hosting
    Browser["User Browser"]:::external
    Hosting["Hosting (Vercel / Static Host)"]:::external

    %% Frontend Layer
    subgraph "Frontend Layer"
        ReactSPA["React SPA<br/>(frontend/src/)"]:::frontend
        Index["App Entry<br/>(index.js)"]:::frontend
        AppComp["App Component (Routing & Layout)<br/>(App.js)"]:::frontend
        Components["UI Components<br/>(components/)"]:::frontend
        PrivateRoute["PrivateRoute Guard<br/>(components/PrivateRoute.js)"]:::frontend
        AdminRoute["AdminRoute Guard<br/>(components/AdminRoute.js)"]:::frontend
        DatabaseContext["DatabaseContext Provider<br/>(context/DatabaseContext.js)"]:::frontend
        AuthContext["AuthContext Provider<br/>(contexts/AuthContext.js)"]:::frontend
        APIService["API Service Client<br/>(services/apiService.js)"]:::frontend
        Pages["Pages / Views<br/>(pages/)"]:::frontend
        DBStatusIndicator["DB Status Indicator<br/>(components/DBStatusIndicator.js)"]:::frontend
    end

    %% Backend Layer
    subgraph "Backend Layer"
        Server["Express Server<br/>(server.js)"]:::backend
        DBConfig["DB Connection Config<br/>(config/db.js)"]:::backend
        Models["Mongoose Models<br/>(models/)"]:::backend
        Controllers["Controllers<br/>(controllers/)"]:::backend
        Routes["Routes<br/>(routes/)"]:::backend
        Middleware["Middleware<br/>(middleware/)"]:::backend
        VercelConfig["Vercel Config<br/>(vercel.json)"]:::backend
    end

    %% Database
    MongoDB["MongoDB"]:::db

    %% Admin Scripts
    subgraph "Admin Scripts (Out-of-Band)"
        CreateAdmin["createAdmin.js"]:::scripts
        ResetAdmin["resetAdminPassword.js"]:::scripts
    end

    %% Interactions
    Browser -->|Loads SPA| Hosting
    Hosting -->|Serves Static| ReactSPA
    ReactSPA -->|Initializes| Index
    Index -->|Renders| AppComp
    AppComp --> Pages
    AppComp --> Components
    Components --> PrivateRoute
    Components --> AdminRoute
    AppComp --> DatabaseContext
    AppComp --> AuthContext
    AppComp --> DBStatusIndicator
    AppComp --> APIService
    APIService -->|HTTP Requests| Server
    Server -->|uses| Middleware
    Middleware -->|auth & error| Controllers
    Controllers -->|CRUD Logic| Models
    Models -->|MongoOps| MongoDB
    MongoDB -->|Data| Models
    Controllers -->|Responses| Server
    Server -->|Sends JSON| APIService
    APIService -->|Data| AppComp

    CreateAdmin -->|connects via DBConfig| DBConfig
    ResetAdmin -->|connects via DBConfig| DBConfig
    DBConfig --> MongoDB

    Hosting -->|Deploys API| Server

    %% Click Events
    click ReactSPA "https://github.com/manhquymqy/student-forum-web/tree/main/frontend/src/"
    click Index "https://github.com/manhquymqy/student-forum-web/blob/main/frontend/src/index.js"
    click AppComp "https://github.com/manhquymqy/student-forum-web/blob/main/frontend/src/App.js"
    click Components "https://github.com/manhquymqy/student-forum-web/tree/main/frontend/src/components/"
    click PrivateRoute "https://github.com/manhquymqy/student-forum-web/blob/main/frontend/src/components/PrivateRoute.js"
    click AdminRoute "https://github.com/manhquymqy/student-forum-web/blob/main/frontend/src/components/AdminRoute.js"
    click DatabaseContext "https://github.com/manhquymqy/student-forum-web/blob/main/frontend/src/context/DatabaseContext.js"
    click AuthContext "https://github.com/manhquymqy/student-forum-web/blob/main/frontend/src/contexts/AuthContext.js"
    click APIService "https://github.com/manhquymqy/student-forum-web/blob/main/frontend/src/services/apiService.js"
    click Pages "https://github.com/manhquymqy/student-forum-web/tree/main/frontend/src/pages/"
    click DBStatusIndicator "https://github.com/manhquymqy/student-forum-web/blob/main/frontend/src/components/DBStatusIndicator.js"
    click Server "https://github.com/manhquymqy/student-forum-web/blob/main/backend/server.js"
    click DBConfig "https://github.com/manhquymqy/student-forum-web/blob/main/backend/config/db.js"
    click Models "https://github.com/manhquymqy/student-forum-web/tree/main/backend/models/"
    click Controllers "https://github.com/manhquymqy/student-forum-web/tree/main/backend/controllers/"
    click Routes "https://github.com/manhquymqy/student-forum-web/tree/main/backend/routes/"
    click Middleware "https://github.com/manhquymqy/student-forum-web/tree/main/backend/middleware/"
    click CreateAdmin "https://github.com/manhquymqy/student-forum-web/blob/main/backend/scripts/createAdmin.js"
    click ResetAdmin "https://github.com/manhquymqy/student-forum-web/blob/main/backend/scripts/resetAdminPassword.js"
    click VercelConfig "https://github.com/manhquymqy/student-forum-web/blob/main/backend/vercel.json"

    %% Styles
    classDef frontend fill:#b3f0b3,stroke:#333,stroke-width:1px
    classDef backend fill:#b3d1f5,stroke:#333,stroke-width:1px
    classDef db fill:#f5c99f,stroke:#333,stroke-width:1px
    classDef scripts fill:#d3d3d3,stroke:#333,stroke-width:1px
    classDef external fill:#e2e2e2,stroke:#333,stroke-width:1px
```
