# nallamdilip0000-bot/rgm architecture

> Architecture diagram of the GitHub repository nallamdilip0000-bot/rgm, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-04). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/nallamdilip0000-bot/rgm
- Repository: https://github.com/nallamdilip0000-bot/rgm

## Overview

RGM is a role-based student project tracker: students authenticate, create and track projects, milestones and tasks; faculty review submissions and deadlines, while administrators oversee users and projects. Express routes expose these workflows to the browser portals, with Firestore-backed services, progress calculation and notifications supporting them. The README documents evaluations, documents, attendance and admin capabilities even though those route implementations were not sampled. Edges reflect the server wiring and sampled calls; undocumented route internals are represented without speculative connections.

Main entry points: [`server.js`](https://github.com/nallamdilip0000-bot/rgm/blob/main/server.js) (Express server), [`src/services/dbService.js`](https://github.com/nallamdilip0000-bot/rgm/blob/main/src/services/dbService.js) (Firestore data service), [`src/routes/milestones.js`](https://github.com/nallamdilip0000-bot/rgm/blob/main/src/routes/milestones.js) (Milestones), [`src/routes/tasks.js`](https://github.com/nallamdilip0000-bot/rgm/blob/main/src/routes/tasks.js) (Tasks)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_web["Role Portals"]
  node_student["Student portal<br/>[student.js]"]
  node_faculty["Faculty portal<br/>[faculty.js]"]
  node_admin["Admin portal<br/>[admin.js]"]
  node_api_client["API client<br/>[api.js]"]
end

subgraph group_api["Application API"]
  node_server["Express server<br/>[server.js]"]
  node_auth_routes["Authentication<br/>[auth.js]"]
  node_auth_mw["Access control<br/>[auth.js]"]
end

subgraph group_domain["Project Workflows"]
  node_projects["Projects<br/>[projects.js]"]
  node_milestones["Milestones<br/>[milestones.js]"]
  node_tasks["Tasks<br/>[tasks.js]"]
  node_evaluations["Evaluations<br/>[evaluations.js]"]
  node_documents["Project documents<br/>[documents.js]"]
  node_attendance["Attendance<br/>[attendance.js]"]
  node_faculty_routes["Faculty review<br/>[faculty.js]"]
  node_admin_routes["Administration<br/>[admin.js]"]
  node_student_routes["Student services<br/>[student.js]"]
  node_notifications_routes["Notifications<br/>[notifications.js]"]
  node_cron["Scheduled endpoints<br/>[cron.js]"]
end

subgraph group_services["Shared Services"]
  node_progress["Progress calculator<br/>[progressService.js]"]
  node_deadline["Deadline checker<br/>[deadlineChecker.js]"]
  node_notify["Notification dispatcher"]
  node_email["Email delivery<br/>[emailService.js]"]
  node_academic["Academic normalization<br/>[academicUtils.js]"]
end

subgraph group_storage["Persistence"]
  node_db_service["Firestore data service<br/>[dbService.js]"]
  node_firebase["Firebase connection<br/>[firebase.js]"]
end

node_user_actor(("Student, faculty, admin"))
node_firestore[("Firebase Firestore")]

node_user_actor -->|"uses"| node_student
node_user_actor -->|"uses"| node_faculty
node_user_actor -->|"uses"| node_admin
node_student -->|"requests API"| node_api_client
node_faculty -->|"requests API"| node_api_client
node_admin -->|"requests API"| node_api_client
node_api_client -.->|"sends requests"| node_server
node_server -->|"mounts routes"| node_auth_routes
node_server -->|"mounts routes"| node_projects
node_server -->|"mounts routes"| node_milestones
node_server -->|"mounts routes"| node_tasks
node_server -->|"mounts routes"| node_evaluations
node_server -->|"mounts routes"| node_documents
node_server -->|"mounts routes"| node_attendance
node_server -->|"mounts routes"| node_faculty_routes
node_server -->|"mounts routes"| node_admin_routes
node_server -->|"mounts routes"| node_student_routes
node_server -->|"mounts routes"| node_notifications_routes
node_server -->|"mounts routes"| node_cron
node_auth_routes -->|"reads accounts"| node_db_service
node_auth_routes -->|"uses token checks"| node_auth_mw
node_auth_mw -->|"checks accounts"| node_db_service
node_projects -.->|"checks access"| node_auth_mw
node_milestones -->|"checks access"| node_auth_mw
node_tasks -->|"checks access"| node_auth_mw
node_projects -->|"reads and writes"| node_db_service
node_milestones -->|"reads and writes"| node_db_service
node_tasks -->|"reads and writes"| node_db_service
node_milestones -->|"recalculates progress"| node_progress
node_tasks -->|"recalculates progress"| node_progress
node_progress -->|"updates progress"| node_db_service
node_milestones -->|"dispatches alerts"| node_notify
node_tasks -->|"dispatches alerts"| node_notify
node_projects -->|"dispatches alerts"| node_notify
node_notify -->|"records notifications"| node_db_service
node_notify -->|"sends email"| node_email
node_server -->|"schedules checks"| node_deadline
node_milestones -->|"runs checks"| node_deadline
node_tasks -->|"runs checks"| node_deadline
node_db_service -->|"uses Firestore client"| node_firebase
node_firebase -->|"connects to"| node_firestore
node_db_service -->|"normalizes records"| node_academic
node_cron -.->|"triggers checks"| node_deadline

click node_student "https://github.com/nallamdilip0000-bot/rgm/blob/main/public/js/student.js"
click node_faculty "https://github.com/nallamdilip0000-bot/rgm/blob/main/public/js/faculty.js"
click node_admin "https://github.com/nallamdilip0000-bot/rgm/blob/main/public/js/admin.js"
click node_api_client "https://github.com/nallamdilip0000-bot/rgm/blob/main/public/js/api.js"
click node_server "https://github.com/nallamdilip0000-bot/rgm/blob/main/server.js"
click node_auth_routes "https://github.com/nallamdilip0000-bot/rgm/blob/main/src/routes/auth.js"
click node_auth_mw "https://github.com/nallamdilip0000-bot/rgm/blob/main/src/middleware/auth.js"
click node_projects "https://github.com/nallamdilip0000-bot/rgm/blob/main/src/routes/projects.js"
click node_milestones "https://github.com/nallamdilip0000-bot/rgm/blob/main/src/routes/milestones.js"
click node_tasks "https://github.com/nallamdilip0000-bot/rgm/blob/main/src/routes/tasks.js"
click node_evaluations "https://github.com/nallamdilip0000-bot/rgm/blob/main/src/routes/evaluations.js"
click node_documents "https://github.com/nallamdilip0000-bot/rgm/blob/main/src/routes/documents.js"
click node_attendance "https://github.com/nallamdilip0000-bot/rgm/blob/main/src/routes/attendance.js"
click node_faculty_routes "https://github.com/nallamdilip0000-bot/rgm/blob/main/src/routes/faculty.js"
click node_admin_routes "https://github.com/nallamdilip0000-bot/rgm/blob/main/src/routes/admin.js"
click node_student_routes "https://github.com/nallamdilip0000-bot/rgm/blob/main/src/routes/student.js"
click node_notifications_routes "https://github.com/nallamdilip0000-bot/rgm/blob/main/src/routes/notifications.js"
click node_cron "https://github.com/nallamdilip0000-bot/rgm/blob/main/src/routes/cron.js"
click node_db_service "https://github.com/nallamdilip0000-bot/rgm/blob/main/src/services/dbService.js"
click node_firebase "https://github.com/nallamdilip0000-bot/rgm/blob/main/src/config/firebase.js"
click node_progress "https://github.com/nallamdilip0000-bot/rgm/blob/main/src/services/progressService.js"
click node_deadline "https://github.com/nallamdilip0000-bot/rgm/blob/main/src/services/deadlineChecker.js"
click node_notify "https://github.com/nallamdilip0000-bot/rgm/blob/main/src/services/notificationService.js"
click node_email "https://github.com/nallamdilip0000-bot/rgm/blob/main/src/services/emailService.js"
click node_academic "https://github.com/nallamdilip0000-bot/rgm/blob/main/src/utils/academicUtils.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_student,node_faculty,node_admin,node_api_client toneBlue
class node_server,node_auth_routes,node_auth_mw,node_firestore toneAmber
class node_projects,node_milestones,node_tasks,node_evaluations,node_documents,node_attendance,node_faculty_routes,node_admin_routes,node_student_routes,node_notifications_routes,node_cron toneMint
class node_progress,node_deadline,node_notify,node_email,node_academic toneRose
class node_db_service,node_firebase,node_user_actor toneIndigo
```

## Components

### Role Portals

- [Student portal](https://github.com/nallamdilip0000-bot/rgm/blob/main/public/js/student.js): `public/js/student.js`
- [Faculty portal](https://github.com/nallamdilip0000-bot/rgm/blob/main/public/js/faculty.js): `public/js/faculty.js`
- [Admin portal](https://github.com/nallamdilip0000-bot/rgm/blob/main/public/js/admin.js): `public/js/admin.js`
- [API client](https://github.com/nallamdilip0000-bot/rgm/blob/main/public/js/api.js): `public/js/api.js`

### Application API

- [Express server](https://github.com/nallamdilip0000-bot/rgm/blob/main/server.js): `server.js`
- [Authentication](https://github.com/nallamdilip0000-bot/rgm/blob/main/src/routes/auth.js): `src/routes/auth.js`
- [Access control](https://github.com/nallamdilip0000-bot/rgm/blob/main/src/middleware/auth.js): `src/middleware/auth.js`

### Project Workflows

- [Projects](https://github.com/nallamdilip0000-bot/rgm/blob/main/src/routes/projects.js): `src/routes/projects.js`
- [Milestones](https://github.com/nallamdilip0000-bot/rgm/blob/main/src/routes/milestones.js): `src/routes/milestones.js`
- [Tasks](https://github.com/nallamdilip0000-bot/rgm/blob/main/src/routes/tasks.js): `src/routes/tasks.js`
- [Evaluations](https://github.com/nallamdilip0000-bot/rgm/blob/main/src/routes/evaluations.js): `src/routes/evaluations.js`
- [Project documents](https://github.com/nallamdilip0000-bot/rgm/blob/main/src/routes/documents.js): `src/routes/documents.js`
- [Attendance](https://github.com/nallamdilip0000-bot/rgm/blob/main/src/routes/attendance.js): `src/routes/attendance.js`
- [Faculty review](https://github.com/nallamdilip0000-bot/rgm/blob/main/src/routes/faculty.js): `src/routes/faculty.js`
- [Administration](https://github.com/nallamdilip0000-bot/rgm/blob/main/src/routes/admin.js): `src/routes/admin.js`
- [Student services](https://github.com/nallamdilip0000-bot/rgm/blob/main/src/routes/student.js): `src/routes/student.js`
- [Notifications](https://github.com/nallamdilip0000-bot/rgm/blob/main/src/routes/notifications.js): `src/routes/notifications.js`
- [Scheduled endpoints](https://github.com/nallamdilip0000-bot/rgm/blob/main/src/routes/cron.js): `src/routes/cron.js`

### Shared Services

- [Progress calculator](https://github.com/nallamdilip0000-bot/rgm/blob/main/src/services/progressService.js): `src/services/progressService.js`
- [Deadline checker](https://github.com/nallamdilip0000-bot/rgm/blob/main/src/services/deadlineChecker.js): `src/services/deadlineChecker.js`
- [Notification dispatcher](https://github.com/nallamdilip0000-bot/rgm/blob/main/src/services/notificationService.js): `src/services/notificationService.js`
- [Email delivery](https://github.com/nallamdilip0000-bot/rgm/blob/main/src/services/emailService.js): `src/services/emailService.js`
- [Academic normalization](https://github.com/nallamdilip0000-bot/rgm/blob/main/src/utils/academicUtils.js): `src/utils/academicUtils.js`

### Persistence

- [Firestore data service](https://github.com/nallamdilip0000-bot/rgm/blob/main/src/services/dbService.js): `src/services/dbService.js`
- [Firebase connection](https://github.com/nallamdilip0000-bot/rgm/blob/main/src/config/firebase.js): `src/config/firebase.js`

### Other components

- **Student, faculty, admin**
- **Firebase Firestore**

## Connections

- Student, faculty, admin → Student portal: uses (evidence: `README.md`)
- Student, faculty, admin → Faculty portal: uses (evidence: `README.md`)
- Student, faculty, admin → Admin portal: uses (evidence: `README.md`)
- Student portal → API client: requests API (evidence: `public/js/student.js`)
- Faculty portal → API client: requests API (evidence: `public/js/faculty.js`)
- Admin portal → API client: requests API (evidence: `public/js/admin.js`)
- API client → Express server: sends requests
- Express server → Authentication: mounts routes (evidence: `server.js`)
- Express server → Projects: mounts routes (evidence: `server.js`)
- Express server → Milestones: mounts routes (evidence: `server.js`)
- Express server → Tasks: mounts routes (evidence: `server.js`)
- Express server → Evaluations: mounts routes (evidence: `server.js`)
- Express server → Project documents: mounts routes (evidence: `server.js`)
- Express server → Attendance: mounts routes (evidence: `server.js`)
- Express server → Faculty review: mounts routes (evidence: `server.js`)
- Express server → Administration: mounts routes (evidence: `server.js`)
- Express server → Student services: mounts routes (evidence: `server.js`)
- Express server → Notifications: mounts routes (evidence: `server.js`)
- Express server → Scheduled endpoints: mounts routes (evidence: `server.js`)
- Authentication → Firestore data service: reads accounts (evidence: `src/routes/auth.js`)
- Authentication → Access control: uses token checks (evidence: `src/routes/auth.js`)
- Access control → Firestore data service: checks accounts (evidence: `src/middleware/auth.js`)
- Projects → Access control: checks access (evidence: `src/routes/projects.js`)
- Milestones → Access control: checks access (evidence: `src/routes/milestones.js`)
- Tasks → Access control: checks access (evidence: `src/routes/tasks.js`)
- Projects → Firestore data service: reads and writes (evidence: `src/routes/projects.js`)
- Milestones → Firestore data service: reads and writes (evidence: `src/routes/milestones.js`)
- Tasks → Firestore data service: reads and writes (evidence: `src/routes/tasks.js`)
- Milestones → Progress calculator: recalculates progress (evidence: `src/routes/milestones.js`)
- Tasks → Progress calculator: recalculates progress (evidence: `src/routes/tasks.js`)
- Progress calculator → Firestore data service: updates progress (evidence: `src/services/progressService.js`)
- Milestones → Notification dispatcher: dispatches alerts (evidence: `src/routes/milestones.js`)
- Tasks → Notification dispatcher: dispatches alerts (evidence: `src/routes/tasks.js`)
- Projects → Notification dispatcher: dispatches alerts (evidence: `src/routes/projects.js`)
- Notification dispatcher → Firestore data service: records notifications (evidence: `src/services/notificationService.js`)
- Notification dispatcher → Email delivery: sends email (evidence: `src/services/notificationService.js`)
- Express server → Deadline checker: schedules checks (evidence: `server.js`)
- Milestones → Deadline checker: runs checks (evidence: `src/routes/milestones.js`)
- Tasks → Deadline checker: runs checks (evidence: `src/routes/tasks.js`)
- Firestore data service → Firebase connection: uses Firestore client (evidence: `src/services/dbService.js`)
- Firebase connection → Firebase Firestore: connects to (evidence: `src/config/firebase.js`)
- Firestore data service → Academic normalization: normalizes records (evidence: `src/services/dbService.js`)
- Scheduled endpoints → Deadline checker: triggers checks
