# ayeshamashiat/pams_backend architecture

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

- Interactive diagram: https://gitdiagram.com/ayeshamashiat/pams_backend
- Repository: https://github.com/ayeshamashiat/pams_backend

## Overview

##### Project type and purpose
- This is a full-stack web application named “Postgraduate Academic Management System (PAMS).”
- Purpose: Support postgraduate thesis and academic workflows (authentication, user roles, supervisor assignment, proposal submission, thesis progress, notifications).

##### File structure
Top-level:
- backend/ — Node.js/Express monolith
– controllers/ (HTTP-route handlers by domain)
– routes/ (Express routers)
– models/ (Mongoose schemas)
– middleware/ (auth, file upload)
– services/ (business logic, e.g. progressService)
– utils/ (email, notifications, initial admin seeding)
– uploads/ (file store for proposals, reports)
– server.js (app entry)
– package.json (dependencies, scripts)
- README.md (project description, stack, setup)
Patterns & conventions:
- MVC-style separation (models/controllers/services)
- RESTful API endpoints by domain (student, faculty, thesis, etc.)
- JWT-based auth and role middleware
- File-storage for PDF uploads
- Nodemailer for email notifications

##### Key insights from README
- Frontend: React + Next.js (hosted separately)
- Backend: Node.js, Express, MongoDB (Mongoose)
- Auth: JWT, bcrypt
- Email notifications via Nodemailer
- Roles: Admin, Student, Faculty, PGC

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Frontend Layer
    subgraph "Frontend"
        direction TB
        NextJS["Next.js (React)"]:::frontend
    end

    %% Backend API Entry
    subgraph "Backend Service (Express.js Monolith)"
        direction TB

        Server["Server.js"]:::api
        click Server "https://github.com/ayeshamashiat/pams_backend/blob/nanziba/backend/server.js"

        %% Routes Layer
        subgraph "Routes"
            direction TB
            AuthRoutes["Auth Routes"]:::api
            click AuthRoutes "https://github.com/ayeshamashiat/pams_backend/blob/nanziba/backend/routes/auth.js"
            StudentRoutes["Student Routes"]:::api
            click StudentRoutes "https://github.com/ayeshamashiat/pams_backend/blob/nanziba/backend/routes/studentRoutes.js"
            FacultyRoutes["Faculty Routes"]:::api
            click FacultyRoutes "https://github.com/ayeshamashiat/pams_backend/blob/nanziba/backend/routes/facultyRoutes.js"
            PgcRoutes["PGC Routes"]:::api
            click PgcRoutes "https://github.com/ayeshamashiat/pams_backend/blob/nanziba/backend/routes/pgcRoutes.js"
            AdminRoutes["Admin Routes"]:::api
            click AdminRoutes "https://github.com/ayeshamashiat/pams_backend/blob/nanziba/backend/routes/adminRoutes.js"
            ThesisRoutes["Thesis Proposal Routes"]:::api
            click ThesisRoutes "https://github.com/ayeshamashiat/pams_backend/blob/nanziba/backend/routes/thesisRoute.js"
            SupervisorAssignmentRoutes["Supervisor Assignment Routes"]:::api
            click SupervisorAssignmentRoutes "https://github.com/ayeshamashiat/pams_backend/blob/nanziba/backend/routes/supervisorAssignmentRoutes.js"
            ThesisProgressRoutes["Thesis Progress Routes"]:::api
            click ThesisProgressRoutes "https://github.com/ayeshamashiat/pams_backend/blob/nanziba/backend/routes/thesisProgressRoutes.js"
            NotificationRoutes["Notification Routes"]:::api
            click NotificationRoutes "https://github.com/ayeshamashiat/pams_backend/blob/nanziba/backend/routes/notificationRoutes.js"
        end

        %% Controllers Layer
        subgraph "Controllers"
            direction TB
            AuthController["Auth Controller"]:::api
            click AuthController "https://github.com/ayeshamashiat/pams_backend/blob/nanziba/backend/controllers/authController.js"
            StudentController["Student Controller"]:::api
            click StudentController "https://github.com/ayeshamashiat/pams_backend/blob/nanziba/backend/controllers/studentController.js"
            FacultyController["Faculty Controller"]:::api
            click FacultyController "https://github.com/ayeshamashiat/pams_backend/blob/nanziba/backend/controllers/facultyController.js"
            PgcController["PGC Controller"]:::api
            click PgcController "https://github.com/ayeshamashiat/pams_backend/blob/nanziba/backend/controllers/pgcController.js"
            UserController["User Controller"]:::api
            click UserController "https://github.com/ayeshamashiat/pams_backend/blob/nanziba/backend/controllers/userController.js"
            SupervisorAssignmentController["Supervisor Assignment Controller"]:::api
            click SupervisorAssignmentController "https://github.com/ayeshamashiat/pams_backend/blob/nanziba/backend/controllers/supervisorAssignmentController.js"
            ThesisProgressController["Thesis Progress Controller"]:::api
            click ThesisProgressController "https://github.com/ayeshamashiat/pams_backend/blob/nanziba/backend/controllers/thesisProgressController.js"
        end

        %% Services Layer
        subgraph "Services"
            direction TB
            ProgressService["Progress Service"]:::api
            click ProgressService "https://github.com/ayeshamashiat/pams_backend/blob/nanziba/backend/services/progressService.js"
        end

        %% Models Layer
        subgraph "Models"
            direction TB
            StudentModel["Student Model"]:::data
            click StudentModel "https://github.com/ayeshamashiat/pams_backend/blob/nanziba/backend/models/student.js"
            StudentCourseModel["StudentCourse Model"]:::data
            click StudentCourseModel "https://github.com/ayeshamashiat/pams_backend/blob/nanziba/backend/models/studentCourse.js"
            FacultyModel["Faculty Model"]:::data
            click FacultyModel "https://github.com/ayeshamashiat/pams_backend/blob/nanziba/backend/models/faculty.js"
            UserModel["User Model"]:::data
            click UserModel "https://github.com/ayeshamashiat/pams_backend/blob/nanziba/backend/models/user.js"
            ThesisProposalModel["ThesisProposal Model"]:::data
            click ThesisProposalModel "https://github.com/ayeshamashiat/pams_backend/blob/nanziba/backend/models/thesisProposal.js"
            SupervisorAssignmentModel["SupervisorAssignment Model"]:::data
            click SupervisorAssignmentModel "https://github.com/ayeshamashiat/pams_backend/blob/nanziba/backend/models/supervisorAssignment.js"
            ThesisProgressModel["ThesisProgress Model"]:::data
            click ThesisProgressModel "https://github.com/ayeshamashiat/pams_backend/blob/nanziba/backend/models/thesisProgress.js"
        end

        %% Middleware Layer
        subgraph "Middleware"
            direction TB
            AuthMiddleware["Auth Middleware"]:::api
            click AuthMiddleware "https://github.com/ayeshamashiat/pams_backend/blob/nanziba/backend/middleware/authMiddleware.js"
            UploadMiddleware["Upload Middleware"]:::api
            click UploadMiddleware "https://github.com/ayeshamashiat/pams_backend/blob/nanziba/backend/middleware/upload.js"
        end

        %% Utils Layer
        subgraph "Utils"
            direction TB
            CreateAdmin["Initial Admin Seeder"]:::api
            click CreateAdmin "https://github.com/ayeshamashiat/pams_backend/blob/nanziba/backend/utils/createAdminUser.js"
            NotificationUtil["Notification Util"]:::api
            click NotificationUtil "https://github.com/ayeshamashiat/pams_backend/blob/nanziba/backend/utils/notification.js"
            SendEmail["SendEmail Util"]:::api
            click SendEmail "https://github.com/ayeshamashiat/pams_backend/blob/nanziba/backend/utils/sendEmail.js"
        end

        %% File Storage
        Uploads["File Storage (uploads/)"]:::data
        click Uploads "https://github.com/ayeshamashiat/pams_backend/tree/nanziba/backend/uploads/"

    end

    %% External Services
    SMTP["SMTP / Email Provider"]:::external
    MongoDB["MongoDB Cluster"]:::data

    %% Connections
    NextJS -->|HTTP/JSON| Server
    Server --> AuthRoutes
    Server --> StudentRoutes
    Server --> FacultyRoutes
    Server --> PgcRoutes
    Server --> AdminRoutes
    Server --> ThesisRoutes
    Server --> SupervisorAssignmentRoutes
    Server --> ThesisProgressRoutes
    Server --> NotificationRoutes

    AuthRoutes -->|calls| AuthController
    StudentRoutes -->|calls| StudentController
    FacultyRoutes -->|calls| FacultyController
    PgcRoutes -->|calls| PgcController
    AdminRoutes -->|calls| UserController
    ThesisRoutes -->|calls| AuthController
    ThesisRoutes -->|calls| UserController
    SupervisorAssignmentRoutes -->|calls| SupervisorAssignmentController
    ThesisProgressRoutes -->|calls| ThesisProgressController
    NotificationRoutes -->|calls| SendEmail

    AuthController --> AuthMiddleware
    AuthController --> UserModel
    AuthController -->|JWT| AuthMiddleware

    StudentController --> ProgressService
    StudentController --> StudentModel
    StudentController --> StudentCourseModel

    FacultyController --> FacultyModel

    PgcController --> UserModel

    SupervisorAssignmentController --> SupervisorAssignmentModel

    ThesisProgressController --> ThesisProgressModel
    ThesisProgressController --> ProgressService

    AuthController --> SendEmail
    ThesisProgressController --> SendEmail

    SendEmail --> SMTP
    NotificationUtil --> SMTP

    UploadMiddleware --> Uploads
    AuthController --> UploadMiddleware
    UserController --> CreateAdmin

    %% Service to Model
    ProgressService --> ThesisProgressModel

    %% All Models to DB
    StudentModel -->|CRUD| MongoDB
    StudentCourseModel -->|CRUD| MongoDB
    FacultyModel -->|CRUD| MongoDB
    UserModel -->|CRUD| MongoDB
    ThesisProposalModel -->|CRUD| MongoDB
    SupervisorAssignmentModel -->|CRUD| MongoDB
    ThesisProgressModel -->|CRUD| MongoDB

    %% Styles
    classDef frontend fill:#1f77b4,stroke:#333,stroke-width:1px,color:#fff
    classDef api fill:#2ca02c,stroke:#333,stroke-width:1px,color:#fff
    classDef data fill:#ff7f0e,stroke:#333,stroke-width:1px,color:#fff
    classDef external fill:#9467bd,stroke:#333,stroke-width:1px,color:#fff
```
