# karamyacoub/ilm-verse architecture

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

- Interactive diagram: https://gitdiagram.com/karamyacoub/ilm-verse
- Repository: https://github.com/karamyacoub/ilm-verse

## Overview

##### Project type and purpose
- ILM-VERSE is a full-stack educational management system.
- Frontend: React + Vite + TailwindCSS (DaisyUI) single-page app.
- Backend: Node.js + Express REST API, with both SQL (Sequelize) and NoSQL (Mongoose) data stores, plus file‐storage for uploads (assignments, events, resources).

##### File structure
- Top-level “Frontend” and “Backend” folders clearly separate client and server.
- Backend:
- app.js / server.js – Express application bootstrap and server startup.
- Middlewares – auth, authorization, file validation.
- routers – Express Router for each role (admin, teacher, student, parent).
- controllers – one per resource (course, quiz, marks, absence, announcements, OTP, file upload/download).
- models – dual-stack persistence:
– models/SQL (Sequelize ORM) connecting to a relational DB.
– models/NOSQL (Mongoose) for document storage of assignments, events, quizzes.
- data – local file system storage for uploaded content.
- Frontend:
- src/pages – top-level routes (home, dashboards per role, login, error).
- src/components – shared UI bits and role-specific UI (admin panels, teacher, student, parent tabs).
- src/store – state management per domain (AuthStore, CourseStore, etc.).
- src/lib/axios.js – configured HTTP client.

##### README for architectural insights
- Role-Based Access Control via middleware layers.
- Hybrid persistence strategy (SQL + NoSQL).
- RESTful endpoint design.
- File upload/download endpoints.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Client Tier
    subgraph "Client (Browser)"
        direction TB
        SPA["React SPA"]:::frontend
        subgraph "UI & Pages"
            direction TB
            Components["UI Components"]:::frontend
            Pages["Pages (Routes)"]:::frontend
        end
        subgraph "State & HTTP"
            direction TB
            Stores["State Stores"]:::frontend
            HTTPClient["HTTP Client (Axios)"]:::frontend
        end
        subgraph "Config & Entry"
            direction TB
            Entry["Main & Config"]:::frontend
        end
    end

    %% Server Tier
    subgraph "Server (API)"
        direction TB
        Bootstrap["API Bootstrap"]:::backend
        subgraph "Middlewares"
            direction TB
            AuthM["authMiddleware"]:::backend
            AuthzM["authorizationMiddleware"]:::backend
            FileVal1["checkFileMiddleware"]:::backend
            FileVal2["checkFilesMiddleware"]:::backend
        end
        subgraph "Routers"
            direction TB
            AdminR["Admin Router"]:::backend
            TeacherR["Teacher Router"]:::backend
            StudentR["Student Router"]:::backend
            ParentR["Parent Router"]:::backend
            SharedR["Shared Router"]:::backend
        end
        subgraph "Controllers"
            direction TB
            AuthC["authController"]:::backend
            AdminC["adminController"]:::backend
            TeacherC["teacherController"]:::backend
            StudentC["studentController"]:::backend
            ParentC["parentController"]:::backend
            AbsenceC["absenceController"]:::backend
            CourseC["courseController"]:::backend
            QuizC["quizController"]:::backend
            MarksC["marksController"]:::backend
            AnnounceC["announcmentController"]:::backend
            OTPC["otpController"]:::backend
            ReportC["reportController"]:::backend
            AssignC["assigmentsController"]:::backend
            GuestC["GuestController"]:::backend
        end
        subgraph "File Handlers"
            direction TB
            UploadDesc["uploadAssigment-Description"]:::backend
            UploadSol["uploadSolution"]:::backend
            UploadEvent["uploadEvent"]:::backend
            UploadCM["uploadContentMiddleWare"]:::backend
            DownloadC["downloadController"]:::backend
        end
        subgraph "Models & Data"
            direction TB
            subgraph "SQL Models"
                direction TB
                SQLModels["Sequelize Models"]:::dbSQL
            end
            subgraph "NoSQL Models"
                direction TB
                NoSQLModels["Mongoose Models"]:::dbNoSQL
            end
            SQLConn["SQL Driver"]:::backend
            ModelIndex["Model Index/Auto"]:::backend
        end
        Storage["Local File Storage"]:::storage
        subgraph "Dev & Config"
            direction TB
            Env["Environment Config"]:::backend
            Tools["Package & Tooling"]:::backend
        end
    end

    %% Databases
    SQLDB[(SQL Database)]:::dbSQL
    NoSQLDB[(NoSQL Database)]:::dbNoSQL

    %% Connections
    SPA -->|"HTTP GET/POST/PUT/DELETE"| Bootstrap
    HTTPClient --> SPA
    Bootstrap --> AuthM
    AuthM --> AuthzM --> FileVal1 --> FileVal2 --> SharedR
    SharedR --> AuthC
    SharedR --> AdminR
    SharedR --> TeacherR
    SharedR --> StudentR
    SharedR --> ParentR

    AdminR --> AdminC
    TeacherR --> TeacherC
    StudentR --> StudentC
    ParentR --> ParentC

    AdminC --> SQLModels
    TeacherC --> SQLModels
    StudentC --> SQLModels
    ParentC --> SQLModels

    AbsenceC --> NoSQLModels
    QuizC --> NoSQLModels
    AssignC --> NoSQLModels
    ReportC --> NoSQLModels

    CourseC --> SQLModels
    MarksC --> SQLModels
    AnnounceC --> SQLModels
    OTPC --> SQLModels

    UploadDesc --> Storage
    UploadSol --> Storage
    UploadEvent --> Storage
    UploadCM --> Storage
    DownloadC --> Storage

    SQLModels --> SQLConn --> SQLDB
    NoSQLModels --> NoSQLDB
    ModelIndex --> SQLModels
    ModelIndex --> NoSQLModels

    Env --> Bootstrap
    Tools --> Bootstrap

    %% Click Events
    click SPA "https://github.com/karamyacoub/ilm-verse/blob/main/Frontend/src/App.jsx"
    click Components "https://github.com/karamyacoub/ilm-verse/tree/main/Frontend/src/components"
    click Pages "https://github.com/karamyacoub/ilm-verse/tree/main/Frontend/src/pages"
    click Stores "https://github.com/karamyacoub/ilm-verse/tree/main/Frontend/src/store"
    click HTTPClient "https://github.com/karamyacoub/ilm-verse/blob/main/Frontend/src/lib/axios.js"
    click Entry "https://github.com/karamyacoub/ilm-verse/blob/main/Frontend/vite.config.js"
    click Bootstrap "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/app.js"
    click Bootstrap "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/server.js"
    click Env "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/config.env"
    click AuthM "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/Middlewares/authMiddleware.js"
    click AuthzM "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/Middlewares/authrizationMiddleware.js"
    click FileVal1 "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/Middlewares/checkFileMiddleware.js"
    click FileVal2 "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/Middlewares/checkFilesMiddleware.js"
    click AdminR "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/routers/adminRouter.js"
    click TeacherR "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/routers/teacherRouter.js"
    click StudentR "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/routers/studentRouter.js"
    click ParentR "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/routers/parentRouter.js"
    click SharedR "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/routers/sharedRouter.js"
    click AuthC "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/controllers/authController.js"
    click AdminC "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/controllers/adminController.js"
    click TeacherC "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/controllers/teacherController.js"
    click StudentC "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/controllers/studentController.js"
    click ParentC "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/controllers/parentController.js"
    click AbsenceC "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/controllers/absenceController.js"
    click CourseC "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/controllers/courseController.js"
    click QuizC "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/controllers/quizController.js"
    click MarksC "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/controllers/marksController.js"
    click AnnounceC "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/controllers/announcmentController.js"
    click OTPC "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/controllers/otpController.js"
    click ReportC "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/controllers/reportController.js"
    click AssignC "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/controllers/assigmentsController.js"
    click GuestC "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/controllers/GuestController.js"
    click UploadDesc "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/controllers/upload/uploadAssigment-Description.js"
    click UploadSol "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/controllers/upload/uploadSolution.js"
    click UploadEvent "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/controllers/upload/uploadEvent.js"
    click UploadCM "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/controllers/upload/uploadContentMiddleWare.js"
    click DownloadC "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/controllers/download/downloadController.js"
    click SQLModels "https://github.com/karamyacoub/ilm-verse/tree/main/Backend/models/SQL"
    click NoSQLModels "https://github.com/karamyacoub/ilm-verse/tree/main/Backend/models/NOSQL"
    click SQLConn "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/models/Connections/SQL-Driver.js"
    click ModelIndex "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/models/index.js"
    click Storage "https://github.com/karamyacoub/ilm-verse/tree/main/Backend/data"
    click Tools "https://github.com/karamyacoub/ilm-verse/blob/main/Backend/package.json"

    %% Styles
    classDef frontend fill:#D0E8FF,stroke:#0366D6,color:#0366D6;
    classDef backend fill:#DFFFE0,stroke:#228B22,color:#228B22;
    classDef dbSQL fill:#FFE8B0,stroke:#E69F00,color:#E69F00;
    classDef dbNoSQL fill:#F0D0FF,stroke:#A020F0,color:#A020F0;
    classDef storage fill:#FFF2E0,stroke:#D2691E,color:#D2691E;
```
