# maheshveluri/fsd-course-project architecture

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

- Interactive diagram: https://gitdiagram.com/maheshveluri/fsd-course-project
- Repository: https://github.com/maheshveluri/fsd-course-project

## Overview

Smart Faculty System is a web application for students to find faculty and view academic information, while faculty and administrators manage availability, profiles, timetables, and student progression. The workflow runs from role-based screens through a shared API client to Express routes and controllers, which read or update MongoDB models. Timetable import/export and academic administration are distinct capabilities. The sampled files show the main route and controller relationships; some client-to-endpoint connections are documented by API paths rather than a complete end-to-end trace.

Main entry points: [`smart-faculty-system/client/src/App.jsx`](https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/client/src/App.jsx) (App routing), [`smart-faculty-system/client/src/services/facultyApi.js`](https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/client/src/services/facultyApi.js) (API client), [`smart-faculty-system/server/controllers/facultyController.js`](https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/server/controllers/facultyController.js) (Faculty management), [`smart-faculty-system/server/routes/facultyRoutes.js`](https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/server/routes/facultyRoutes.js) (Faculty routes)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["Web client"]
  node_app["App routing<br/>[App.jsx]"]
  node_search["Faculty search"]
  node_status["Faculty status"]
  node_academic_panel["Academic admin"]
  node_faculty_card["Faculty card<br/>[FacultyCard.jsx]"]
  node_auth_pages["Login and reset<br/>[StudentLogin.jsx]"]
  node_faculty_login["Faculty login<br/>[FacultyLogin.jsx]"]
  node_admin_login["Admin login<br/>[AdminLogin.jsx]"]
  node_reset["Password reset<br/>[ResetPassword.jsx]"]
  node_api_client["API client<br/>[facultyApi.js]"]
end

subgraph group_api["API and access"]
  node_server["HTTP server<br/>[server.js]"]
  node_faculty_routes["Faculty routes<br/>[facultyRoutes.js]"]
  node_student_routes["Student routes<br/>[studentRoutes.js]"]
  node_auth["Token access<br/>[facultyAuth.js]"]
  node_password_controller["Password recovery"]
end

subgraph group_faculty["Faculty operations"]
  node_faculty_controller["Faculty management"]
  node_faculty_data["Faculty seed data<br/>[sampleFaculty.js]"]
  node_branch_code["Branch codes<br/>[branchCode.js]"]
end

subgraph group_academics["Academic records"]
  node_academic_controller["Academic progression"]
  node_student_controller["Student accounts"]
  node_timetable_controller["Timetable operations"]
end

subgraph group_persistence["Persistent data"]
  node_faculty_store[("Faculty records<br/>[Faculty.js]")]
  node_student_store[("Student records<br/>[Student.js]")]
  node_settings_store[("Academic settings")]
  node_timetable_store[("Timetable records<br/>[Timetable.js]")]
  node_other_models[("Auth and import models")]
end

node_student(("Student"))
node_faculty_actor(("Faculty"))
node_admin_actor(("Administrator"))

node_student -->|"uses"| node_app
node_faculty_actor -->|"uses"| node_app
node_admin_actor -->|"uses"| node_app
node_app -->|"renders"| node_search
node_app -->|"renders"| node_status
node_app -->|"renders"| node_auth_pages
node_app -->|"renders"| node_faculty_login
node_app -->|"renders"| node_admin_login
node_app -->|"renders"| node_reset
node_status -->|"renders"| node_academic_panel
node_search -->|"renders"| node_faculty_card
node_app -->|"loads faculty"| node_api_client
node_search -->|"requests data"| node_api_client
node_status -->|"updates data"| node_api_client
node_academic_panel -->|"requests data"| node_api_client
node_auth_pages -->|"authenticates"| node_api_client
node_faculty_login -->|"authenticates"| node_api_client
node_admin_login -->|"authenticates"| node_api_client
node_reset -->|"resets password"| node_api_client
node_api_client -->|"calls API"| node_faculty_routes
node_api_client -->|"calls API"| node_student_routes
node_server -->|"mounts"| node_faculty_routes
node_server -->|"mounts"| node_student_routes
node_server -->|"migrates timetables"| node_timetable_controller
node_faculty_routes -->|"dispatches"| node_faculty_controller
node_faculty_routes -->|"dispatches"| node_academic_controller
node_faculty_routes -->|"dispatches"| node_timetable_controller
node_faculty_routes -->|"dispatches"| node_password_controller
node_student_routes -->|"dispatches"| node_student_controller
node_student_routes -->|"dispatches"| node_password_controller
node_faculty_routes -->|"guards routes"| node_auth
node_student_routes -->|"guards routes"| node_auth
node_faculty_controller -->|"creates tokens"| node_auth
node_student_controller -->|"creates tokens"| node_auth
node_faculty_controller -->|"reads and writes"| node_faculty_store
node_faculty_controller -->|"reads settings"| node_settings_store
node_faculty_controller -->|"imports timetable"| node_timetable_store
node_faculty_controller -->|"gets branch code"| node_branch_code
node_faculty_controller -->|"checks active term"| node_timetable_controller
node_academic_controller -->|"reads and writes"| node_settings_store
node_academic_controller -->|"promotes students"| node_student_store
node_academic_controller -->|"queries timetable"| node_timetable_store
node_student_controller -->|"reads and writes"| node_student_store
node_student_controller -->|"reads placement"| node_settings_store
node_timetable_controller -->|"reads settings"| node_settings_store
node_timetable_controller -->|"reads faculty"| node_faculty_store
node_timetable_controller -->|"reads and writes"| node_timetable_store
node_faculty_controller -->|"uses admin and import records"| node_other_models

click node_app "https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/client/src/App.jsx"
click node_search "https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/client/src/pages/StudentFacultySearch.jsx"
click node_status "https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/client/src/pages/FacultyStatusUpdate.jsx"
click node_academic_panel "https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/client/src/components/AcademicAdminPanel.jsx"
click node_faculty_card "https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/client/src/components/FacultyCard.jsx"
click node_auth_pages "https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/client/src/pages/StudentLogin.jsx"
click node_faculty_login "https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/client/src/pages/FacultyLogin.jsx"
click node_admin_login "https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/client/src/pages/AdminLogin.jsx"
click node_reset "https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/client/src/pages/ResetPassword.jsx"
click node_api_client "https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/client/src/services/facultyApi.js"
click node_server "https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/server/server.js"
click node_faculty_routes "https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/server/routes/facultyRoutes.js"
click node_student_routes "https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/server/routes/studentRoutes.js"
click node_auth "https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/server/middleware/facultyAuth.js"
click node_faculty_controller "https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/server/controllers/facultyController.js"
click node_faculty_data "https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/server/data/sampleFaculty.js"
click node_branch_code "https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/server/branchCode.js"
click node_academic_controller "https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/server/controllers/academicController.js"
click node_student_controller "https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/server/controllers/studentController.js"
click node_timetable_controller "https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/server/controllers/timetableController.js"
click node_password_controller "https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/server/controllers/passwordResetController.js"
click node_faculty_store "https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/server/models/Faculty.js"
click node_student_store "https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/server/models/Student.js"
click node_settings_store "https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/server/models/AcademicSettings.js"
click node_timetable_store "https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/server/models/Timetable.js"
click node_other_models "https://github.com/maheshveluri/fsd-course-project/tree/main/smart-faculty-system/server/models"

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_search,node_status,node_academic_panel,node_faculty_card,node_auth_pages,node_faculty_login,node_admin_login,node_reset,node_api_client toneBlue
class node_server,node_faculty_routes,node_student_routes,node_auth,node_password_controller toneAmber
class node_faculty_controller,node_faculty_data,node_branch_code toneMint
class node_academic_controller,node_student_controller,node_timetable_controller toneRose
class node_faculty_store,node_student_store,node_settings_store,node_timetable_store,node_other_models,node_student,node_faculty_actor,node_admin_actor toneIndigo
```

## Components

### Web client

- [App routing](https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/client/src/App.jsx): `smart-faculty-system/client/src/App.jsx`
- [Faculty search](https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/client/src/pages/StudentFacultySearch.jsx): `smart-faculty-system/client/src/pages/StudentFacultySearch.jsx`
- [Faculty status](https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/client/src/pages/FacultyStatusUpdate.jsx): `smart-faculty-system/client/src/pages/FacultyStatusUpdate.jsx`
- [Academic admin](https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/client/src/components/AcademicAdminPanel.jsx): `smart-faculty-system/client/src/components/AcademicAdminPanel.jsx`
- [Faculty card](https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/client/src/components/FacultyCard.jsx): `smart-faculty-system/client/src/components/FacultyCard.jsx`
- [Login and reset](https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/client/src/pages/StudentLogin.jsx): `smart-faculty-system/client/src/pages/StudentLogin.jsx`
- [Faculty login](https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/client/src/pages/FacultyLogin.jsx): `smart-faculty-system/client/src/pages/FacultyLogin.jsx`
- [Admin login](https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/client/src/pages/AdminLogin.jsx): `smart-faculty-system/client/src/pages/AdminLogin.jsx`
- [Password reset](https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/client/src/pages/ResetPassword.jsx): `smart-faculty-system/client/src/pages/ResetPassword.jsx`
- [API client](https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/client/src/services/facultyApi.js): `smart-faculty-system/client/src/services/facultyApi.js`

### API and access

- [HTTP server](https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/server/server.js): `smart-faculty-system/server/server.js`
- [Faculty routes](https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/server/routes/facultyRoutes.js): `smart-faculty-system/server/routes/facultyRoutes.js`
- [Student routes](https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/server/routes/studentRoutes.js): `smart-faculty-system/server/routes/studentRoutes.js`
- [Token access](https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/server/middleware/facultyAuth.js): `smart-faculty-system/server/middleware/facultyAuth.js`
- [Password recovery](https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/server/controllers/passwordResetController.js): `smart-faculty-system/server/controllers/passwordResetController.js`

### Faculty operations

- [Faculty management](https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/server/controllers/facultyController.js): `smart-faculty-system/server/controllers/facultyController.js`
- [Faculty seed data](https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/server/data/sampleFaculty.js): `smart-faculty-system/server/data/sampleFaculty.js`
- [Branch codes](https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/server/branchCode.js): `smart-faculty-system/server/branchCode.js`

### Academic records

- [Academic progression](https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/server/controllers/academicController.js): `smart-faculty-system/server/controllers/academicController.js`
- [Student accounts](https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/server/controllers/studentController.js): `smart-faculty-system/server/controllers/studentController.js`
- [Timetable operations](https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/server/controllers/timetableController.js): `smart-faculty-system/server/controllers/timetableController.js`

### Persistent data

- [Faculty records](https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/server/models/Faculty.js): `smart-faculty-system/server/models/Faculty.js`
- [Student records](https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/server/models/Student.js): `smart-faculty-system/server/models/Student.js`
- [Academic settings](https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/server/models/AcademicSettings.js): `smart-faculty-system/server/models/AcademicSettings.js`
- [Timetable records](https://github.com/maheshveluri/fsd-course-project/blob/main/smart-faculty-system/server/models/Timetable.js): `smart-faculty-system/server/models/Timetable.js`
- [Auth and import models](https://github.com/maheshveluri/fsd-course-project/tree/main/smart-faculty-system/server/models): `smart-faculty-system/server/models`

### Other components

- **Student**
- **Faculty**
- **Administrator**

## Connections

- Student → App routing: uses
- Faculty → App routing: uses
- Administrator → App routing: uses
- App routing → Faculty search: renders (evidence: `smart-faculty-system/client/src/App.jsx`)
- App routing → Faculty status: renders (evidence: `smart-faculty-system/client/src/App.jsx`)
- App routing → Login and reset: renders (evidence: `smart-faculty-system/client/src/App.jsx`)
- App routing → Faculty login: renders (evidence: `smart-faculty-system/client/src/App.jsx`)
- App routing → Admin login: renders (evidence: `smart-faculty-system/client/src/App.jsx`)
- App routing → Password reset: renders (evidence: `smart-faculty-system/client/src/App.jsx`)
- Faculty status → Academic admin: renders (evidence: `smart-faculty-system/client/src/pages/FacultyStatusUpdate.jsx`)
- Faculty search → Faculty card: renders
- App routing → API client: loads faculty (evidence: `smart-faculty-system/client/src/App.jsx`)
- Faculty search → API client: requests data (evidence: `smart-faculty-system/client/src/pages/StudentFacultySearch.jsx`)
- Faculty status → API client: updates data (evidence: `smart-faculty-system/client/src/pages/FacultyStatusUpdate.jsx`)
- Academic admin → API client: requests data (evidence: `smart-faculty-system/client/src/components/AcademicAdminPanel.jsx`)
- Login and reset → API client: authenticates (evidence: `smart-faculty-system/client/src/pages/StudentLogin.jsx`)
- Faculty login → API client: authenticates (evidence: `smart-faculty-system/client/src/pages/FacultyLogin.jsx`)
- Admin login → API client: authenticates (evidence: `smart-faculty-system/client/src/pages/AdminLogin.jsx`)
- Password reset → API client: resets password
- API client → Faculty routes: calls API (evidence: `smart-faculty-system/client/src/services/facultyApi.js`)
- API client → Student routes: calls API (evidence: `smart-faculty-system/client/src/services/facultyApi.js`)
- HTTP server → Faculty routes: mounts (evidence: `smart-faculty-system/server/server.js`)
- HTTP server → Student routes: mounts (evidence: `smart-faculty-system/server/server.js`)
- HTTP server → Timetable operations: migrates timetables (evidence: `smart-faculty-system/server/server.js`)
- Faculty routes → Faculty management: dispatches (evidence: `smart-faculty-system/server/routes/facultyRoutes.js`)
- Faculty routes → Academic progression: dispatches (evidence: `smart-faculty-system/server/routes/facultyRoutes.js`)
- Faculty routes → Timetable operations: dispatches (evidence: `smart-faculty-system/server/routes/facultyRoutes.js`)
- Faculty routes → Password recovery: dispatches (evidence: `smart-faculty-system/server/routes/facultyRoutes.js`)
- Student routes → Student accounts: dispatches (evidence: `smart-faculty-system/server/routes/studentRoutes.js`)
- Student routes → Password recovery: dispatches (evidence: `smart-faculty-system/server/routes/studentRoutes.js`)
- Faculty routes → Token access: guards routes (evidence: `smart-faculty-system/server/routes/facultyRoutes.js`)
- Student routes → Token access: guards routes (evidence: `smart-faculty-system/server/routes/studentRoutes.js`)
- Faculty management → Token access: creates tokens (evidence: `smart-faculty-system/server/controllers/facultyController.js`)
- Student accounts → Token access: creates tokens (evidence: `smart-faculty-system/server/controllers/studentController.js`)
- Faculty management → Faculty records: reads and writes (evidence: `smart-faculty-system/server/controllers/facultyController.js`)
- Faculty management → Academic settings: reads settings (evidence: `smart-faculty-system/server/controllers/facultyController.js`)
- Faculty management → Timetable records: imports timetable (evidence: `smart-faculty-system/server/controllers/facultyController.js`)
- Faculty management → Branch codes: gets branch code (evidence: `smart-faculty-system/server/controllers/facultyController.js`)
- Faculty management → Timetable operations: checks active term (evidence: `smart-faculty-system/server/controllers/facultyController.js`)
- Academic progression → Academic settings: reads and writes (evidence: `smart-faculty-system/server/controllers/academicController.js`)
- Academic progression → Student records: promotes students (evidence: `smart-faculty-system/server/controllers/academicController.js`)
- Academic progression → Timetable records: queries timetable (evidence: `smart-faculty-system/server/controllers/academicController.js`)
- Student accounts → Student records: reads and writes (evidence: `smart-faculty-system/server/controllers/studentController.js`)
- Student accounts → Academic settings: reads placement (evidence: `smart-faculty-system/server/controllers/studentController.js`)
- Timetable operations → Academic settings: reads settings (evidence: `smart-faculty-system/server/controllers/timetableController.js`)
- Timetable operations → Faculty records: reads faculty (evidence: `smart-faculty-system/server/controllers/timetableController.js`)
- Timetable operations → Timetable records: reads and writes (evidence: `smart-faculty-system/server/controllers/timetableController.js`)
- Faculty management → Auth and import models: uses admin and import records (evidence: `smart-faculty-system/server/controllers/facultyController.js`)
