# kaviee31/review-desk architecture

> Architecture diagram of the GitHub repository kaviee31/review-desk, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-22). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/kaviee31/review-desk
- Repository: https://github.com/kaviee31/review-desk

## Overview

Review Desk is a role-based academic project-review application. Users sign in and enter student, teacher, coordinator, HOD, or admin workflows; these cover enrollment, student and project oversight, panel reviews, marks, reports, and announcements. The React app routes role-protected pages, while its components use Firebase and the Express backend for data and operations. The backend also persists Telegram links and supports a Telegram bot. Several capabilities are indicated by component names and imports, but their internal behavior was not sampled; those links are not expanded beyond documented routing and shown calls.

Main entry points: [`frontend/src/App.jsx`](https://github.com/kaviee31/review-desk/blob/master/frontend/src/App.jsx) (Routes and Roles), [`backend/server.js`](https://github.com/kaviee31/review-desk/blob/master/backend/server.js) (Express API), [`frontend/src/components/TeacherDashboard.jsx`](https://github.com/kaviee31/review-desk/blob/master/frontend/src/components/TeacherDashboard.jsx) (Teacher Dashboard), [`backend/telegramBot.js`](https://github.com/kaviee31/review-desk/blob/master/backend/telegramBot.js) (Telegram Bot)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_web["Web Application"]
  node_app["Routes and Roles<br/>[App.jsx]"]
  node_rolecontext["Active Role<br/>[RoleContext.jsx]"]
  node_login["Sign In and Signup<br/>[Login.jsx]"]
end

subgraph group_academic["Academic Workflows"]
  node_student["Student Dashboard"]
  node_courses["Student Courses<br/>[StudentCourses.jsx]"]
  node_teacher["Teacher Dashboard"]
  node_enrolled["Enrollment and Reviews"]
  node_panelreview["Panel Reviews"]
  node_coord["Coordinator Dashboard"]
  node_coordstudents["Coordinator Students"]
  node_hod["HOD Dashboard<br/>[HODDashboard.jsx]"]
  node_admin["Admin Dashboard<br/>[AdminDashboard.jsx]"]
  node_adminpanels["Panel Management"]
  node_reports["Reports<br/>[ReportPage.jsx]"]
end

subgraph group_services["Backend Services"]
  node_firebase[("Firebase Auth and Firestore<br/>[firebase.js]")]
  node_api["Express API<br/>[server.js]"]
  node_mongo[("MongoDB Records<br/>[server.js]")]
end

subgraph group_messaging["Messaging"]
  node_chatuser[("Telegram Link Record<br/>[ChatUser.js]")]
  node_bot["Telegram Bot<br/>[telegramBot.js]"]
end

node_user(("User"))
node_telegram(("Telegram"))
node_email(("EmailJS"))

node_user -->|"opens"| node_app
node_app -->|"routes to"| node_login
node_app -->|"routes to"| node_student
node_app -->|"routes to"| node_courses
node_app -->|"routes to"| node_teacher
node_app -->|"routes to"| node_enrolled
node_app -->|"routes to"| node_panelreview
node_app -->|"routes to"| node_coord
node_app -->|"routes to"| node_coordstudents
node_app -->|"routes to"| node_hod
node_app -->|"routes to"| node_admin
node_app -->|"routes to"| node_adminpanels
node_app -->|"routes to"| node_reports
node_login -->|"authenticates with"| node_firebase
node_rolecontext -->|"persists role"| node_firebase
node_teacher -->|"fetches courses"| node_api
node_teacher -->|"sends announcements"| node_email
node_teacher -->|"sends announcements"| node_telegram
node_enrolled -->|"loads and updates"| node_api
node_panelreview -->|"loads and saves marks"| node_api
node_api -->|"reads and writes"| node_mongo
node_api -->|"saves chat links"| node_chatuser
node_bot -->|"links chat ID"| node_api
node_user -->|"messages"| node_bot
node_bot -->|"polls and replies"| node_telegram

click node_app "https://github.com/kaviee31/review-desk/blob/master/frontend/src/App.jsx"
click node_rolecontext "https://github.com/kaviee31/review-desk/blob/master/frontend/src/contexts/RoleContext.jsx"
click node_firebase "https://github.com/kaviee31/review-desk/blob/master/frontend/src/firebase.js"
click node_login "https://github.com/kaviee31/review-desk/blob/master/frontend/src/components/Login.jsx"
click node_student "https://github.com/kaviee31/review-desk/blob/master/frontend/src/components/StudentDashboard.jsx"
click node_courses "https://github.com/kaviee31/review-desk/blob/master/frontend/src/components/StudentCourses.jsx"
click node_teacher "https://github.com/kaviee31/review-desk/blob/master/frontend/src/components/TeacherDashboard.jsx"
click node_enrolled "https://github.com/kaviee31/review-desk/blob/master/frontend/src/components/EnrolledStudents.jsx"
click node_panelreview "https://github.com/kaviee31/review-desk/blob/master/frontend/src/components/PanelReviewPage.jsx"
click node_coord "https://github.com/kaviee31/review-desk/blob/master/frontend/src/components/CoordinatorDashboard.jsx"
click node_coordstudents "https://github.com/kaviee31/review-desk/blob/master/frontend/src/components/CoordinatorStudentsView.jsx"
click node_hod "https://github.com/kaviee31/review-desk/blob/master/frontend/src/components/HODDashboard.jsx"
click node_admin "https://github.com/kaviee31/review-desk/blob/master/frontend/src/components/AdminDashboard.jsx"
click node_adminpanels "https://github.com/kaviee31/review-desk/blob/master/frontend/src/components/AdminPanelManagement.jsx"
click node_reports "https://github.com/kaviee31/review-desk/blob/master/frontend/src/components/ReportPage.jsx"
click node_api "https://github.com/kaviee31/review-desk/blob/master/backend/server.js"
click node_mongo "https://github.com/kaviee31/review-desk/blob/master/backend/server.js"
click node_chatuser "https://github.com/kaviee31/review-desk/blob/master/backend/models/ChatUser.js"
click node_bot "https://github.com/kaviee31/review-desk/blob/master/backend/telegramBot.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_app,node_rolecontext,node_login,node_user toneBlue
class node_student,node_courses,node_teacher,node_enrolled,node_panelreview,node_coord,node_coordstudents,node_hod,node_admin,node_adminpanels,node_reports toneAmber
class node_firebase,node_api,node_mongo toneMint
class node_chatuser,node_bot toneRose
class node_telegram,node_email toneIndigo
```

## Components

### Web Application

- [Routes and Roles](https://github.com/kaviee31/review-desk/blob/master/frontend/src/App.jsx): `frontend/src/App.jsx`
- [Active Role](https://github.com/kaviee31/review-desk/blob/master/frontend/src/contexts/RoleContext.jsx): `frontend/src/contexts/RoleContext.jsx`
- [Sign In and Signup](https://github.com/kaviee31/review-desk/blob/master/frontend/src/components/Login.jsx): `frontend/src/components/Login.jsx`

### Academic Workflows

- [Student Dashboard](https://github.com/kaviee31/review-desk/blob/master/frontend/src/components/StudentDashboard.jsx): `frontend/src/components/StudentDashboard.jsx`
- [Student Courses](https://github.com/kaviee31/review-desk/blob/master/frontend/src/components/StudentCourses.jsx): `frontend/src/components/StudentCourses.jsx`
- [Teacher Dashboard](https://github.com/kaviee31/review-desk/blob/master/frontend/src/components/TeacherDashboard.jsx): `frontend/src/components/TeacherDashboard.jsx`
- [Enrollment and Reviews](https://github.com/kaviee31/review-desk/blob/master/frontend/src/components/EnrolledStudents.jsx): `frontend/src/components/EnrolledStudents.jsx`
- [Panel Reviews](https://github.com/kaviee31/review-desk/blob/master/frontend/src/components/PanelReviewPage.jsx): `frontend/src/components/PanelReviewPage.jsx`
- [Coordinator Dashboard](https://github.com/kaviee31/review-desk/blob/master/frontend/src/components/CoordinatorDashboard.jsx): `frontend/src/components/CoordinatorDashboard.jsx`
- [Coordinator Students](https://github.com/kaviee31/review-desk/blob/master/frontend/src/components/CoordinatorStudentsView.jsx): `frontend/src/components/CoordinatorStudentsView.jsx`
- [HOD Dashboard](https://github.com/kaviee31/review-desk/blob/master/frontend/src/components/HODDashboard.jsx): `frontend/src/components/HODDashboard.jsx`
- [Admin Dashboard](https://github.com/kaviee31/review-desk/blob/master/frontend/src/components/AdminDashboard.jsx): `frontend/src/components/AdminDashboard.jsx`
- [Panel Management](https://github.com/kaviee31/review-desk/blob/master/frontend/src/components/AdminPanelManagement.jsx): `frontend/src/components/AdminPanelManagement.jsx`
- [Reports](https://github.com/kaviee31/review-desk/blob/master/frontend/src/components/ReportPage.jsx): `frontend/src/components/ReportPage.jsx`

### Backend Services

- [Firebase Auth and Firestore](https://github.com/kaviee31/review-desk/blob/master/frontend/src/firebase.js): `frontend/src/firebase.js`
- [Express API](https://github.com/kaviee31/review-desk/blob/master/backend/server.js): `backend/server.js`
- [MongoDB Records](https://github.com/kaviee31/review-desk/blob/master/backend/server.js): `backend/server.js`

### Messaging

- [Telegram Link Record](https://github.com/kaviee31/review-desk/blob/master/backend/models/ChatUser.js): `backend/models/ChatUser.js`
- [Telegram Bot](https://github.com/kaviee31/review-desk/blob/master/backend/telegramBot.js): `backend/telegramBot.js`

### Other components

- **User**
- **Telegram**
- **EmailJS**

## Connections

- User → Routes and Roles: opens (evidence: `frontend/src/App.jsx`)
- Routes and Roles → Sign In and Signup: routes to (evidence: `frontend/src/App.jsx`)
- Routes and Roles → Student Dashboard: routes to (evidence: `frontend/src/App.jsx`)
- Routes and Roles → Student Courses: routes to (evidence: `frontend/src/App.jsx`)
- Routes and Roles → Teacher Dashboard: routes to (evidence: `frontend/src/App.jsx`)
- Routes and Roles → Enrollment and Reviews: routes to (evidence: `frontend/src/App.jsx`)
- Routes and Roles → Panel Reviews: routes to (evidence: `frontend/src/App.jsx`)
- Routes and Roles → Coordinator Dashboard: routes to (evidence: `frontend/src/App.jsx`)
- Routes and Roles → Coordinator Students: routes to (evidence: `frontend/src/App.jsx`)
- Routes and Roles → HOD Dashboard: routes to (evidence: `frontend/src/App.jsx`)
- Routes and Roles → Admin Dashboard: routes to (evidence: `frontend/src/App.jsx`)
- Routes and Roles → Panel Management: routes to (evidence: `frontend/src/App.jsx`)
- Routes and Roles → Reports: routes to (evidence: `frontend/src/App.jsx`)
- Sign In and Signup → Firebase Auth and Firestore: authenticates with (evidence: `frontend/src/components/Login.jsx`)
- Active Role → Firebase Auth and Firestore: persists role (evidence: `frontend/src/contexts/RoleContext.jsx`)
- Teacher Dashboard → Express API: fetches courses (evidence: `frontend/src/components/TeacherDashboard.jsx`)
- Teacher Dashboard → EmailJS: sends announcements (evidence: `frontend/src/components/TeacherDashboard.jsx`)
- Teacher Dashboard → Telegram: sends announcements (evidence: `frontend/src/components/TeacherDashboard.jsx`)
- Enrollment and Reviews → Express API: loads and updates (evidence: `frontend/src/components/EnrolledStudents.jsx`)
- Panel Reviews → Express API: loads and saves marks (evidence: `frontend/src/components/PanelReviewPage.jsx`)
- Express API → MongoDB Records: reads and writes (evidence: `backend/server.js`)
- Express API → Telegram Link Record: saves chat links (evidence: `backend/server.js`)
- Telegram Bot → Express API: links chat ID (evidence: `backend/telegramBot.js`)
- User → Telegram Bot: messages (evidence: `backend/telegramBot.js`)
- Telegram Bot → Telegram: polls and replies (evidence: `backend/telegramBot.js`)
