# utkarshdagur/hostel-complaint-tracker architecture

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

- Interactive diagram: https://gitdiagram.com/utkarshdagur/hostel-complaint-tracker
- Repository: https://github.com/utkarshdagur/hostel-complaint-tracker

## Overview

HostelCare lets students register and submit hostel complaints, then track their status and manager comments; managers triage, assign, update, and analyze complaints. The browser’s role-based pages use a service layer that can switch between the REST API and mock mode. The API authenticates users, applies server-side complaint priority and validation, and reads and writes MongoDB records. The README also documents photo attachments, student statistics, search/filtering, and analytics. Some feature implementations were not excerpted, so edges for them rely on README documentation rather than inspected source.

Main entry points: [`frontend/src/services/api.js`](https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/frontend/src/services/api.js) (API and mock service), [`backend/server.js`](https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/backend/server.js) (Express server), [`frontend/src/App.jsx`](https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/frontend/src/App.jsx) (Role-based routes), [`frontend/src/pages/manager`](https://github.com/utkarshdagur/hostel-complaint-tracker/tree/main/frontend/src/pages/manager) (Manager workflows)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["Web application"]
  node_app["Role-based routes<br/>[App.jsx]"]
  node_student_ui["Student workflows"]
  node_manager_ui["Manager workflows"]
  node_auth_ui["Login and profile"]
  node_analytics_ui["Analytics views<br/>[Analytics.jsx]"]
  node_service["API and mock service<br/>[api.js]"]
  node_auth_context["Session state<br/>[AuthContext.jsx]"]
  node_fetch["Data fetching<br/>[useFetch.js]"]
end

subgraph group_api["REST API"]
  node_complaint_routes["Complaint routes<br/>[complaintRoutes.js]"]
  node_auth_routes["Authentication routes<br/>[authRoutes.js]"]
  node_student_routes["Student directory<br/>[studentRoutes.js]"]
  node_analytics_routes["Analytics endpoints<br/>[analyticsRoutes.js]"]
  node_server["Express server<br/>[server.js]"]
  node_access["Authentication and roles<br/>[auth.js]"]
end

subgraph group_domain["Complaint operations"]
  node_auth_controller["Account operations<br/>[authController.js]"]
  node_complaint_controller["Complaint lifecycle"]
  node_priority_validation["Priority and validation<br/>[complaints.js]"]
  node_student_directory["Student statistics<br/>[studentRoutes.js]"]
end

subgraph group_data["Persistence"]
  node_users[("User records<br/>[User.js]")]
  node_complaints[("Complaint records<br/>[Complaint.js]")]
end

node_student(("Student"))
node_manager(("Manager"))
node_mongo[("MongoDB")]

node_student -->|"uses"| node_app
node_manager -->|"uses"| node_app
node_app -->|"routes"| node_student_ui
node_app -->|"routes"| node_manager_ui
node_app -->|"routes"| node_auth_ui
node_student_ui -->|"requests data"| node_service
node_manager_ui -->|"requests data"| node_service
node_manager_ui -->|"routes"| node_analytics_ui
node_analytics_ui -.->|"requests analytics"| node_service
node_auth_ui -->|"uses session"| node_auth_context
node_student_ui -->|"loads data"| node_fetch
node_manager_ui -->|"loads data"| node_fetch
node_fetch -->|"calls"| node_service
node_service -.->|"HTTP REST"| node_server
node_service -.->|"mock responses"| node_student_ui
node_server -->|"mounts"| node_complaint_routes
node_server -->|"mounts"| node_auth_routes
node_server -->|"mounts"| node_student_routes
node_server -->|"mounts"| node_analytics_routes
node_auth_routes -->|"dispatches"| node_auth_controller
node_complaint_routes -->|"protects"| node_access
node_complaint_routes -->|"dispatches"| node_complaint_controller
node_auth_routes -->|"protects"| node_access
node_auth_controller -->|"reads/writes"| node_users
node_access -->|"loads account"| node_users
node_complaint_controller -->|"reads/writes"| node_complaints
node_complaint_controller -->|"derives priority"| node_priority_validation
node_student_routes -->|"queries students"| node_users
node_student_routes -->|"aggregates counts"| node_complaints
node_analytics_routes -->|"queries analytics"| node_complaints
node_analytics_routes -->|"queries accounts"| node_users
node_users -.->|"persists"| node_mongo
node_complaints -.->|"persists"| node_mongo
node_manager -.->|"views directory"| node_student_directory
node_student -.->|"submits and tracks"| node_student_ui
node_manager -.->|"triages complaints"| node_manager_ui

click node_app "https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/frontend/src/App.jsx"
click node_student_ui "https://github.com/utkarshdagur/hostel-complaint-tracker/tree/main/frontend/src/pages/student"
click node_manager_ui "https://github.com/utkarshdagur/hostel-complaint-tracker/tree/main/frontend/src/pages/manager"
click node_auth_ui "https://github.com/utkarshdagur/hostel-complaint-tracker/tree/main/frontend/src/pages/auth"
click node_analytics_ui "https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/frontend/src/pages/manager/Analytics.jsx"
click node_service "https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/frontend/src/services/api.js"
click node_auth_context "https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/frontend/src/context/AuthContext.jsx"
click node_fetch "https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/frontend/src/hooks/useFetch.js"
click node_complaint_routes "https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/backend/routes/complaintRoutes.js"
click node_auth_routes "https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/backend/routes/authRoutes.js"
click node_student_routes "https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/backend/routes/studentRoutes.js"
click node_analytics_routes "https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/backend/routes/analyticsRoutes.js"
click node_server "https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/backend/server.js"
click node_auth_controller "https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/backend/controllers/authController.js"
click node_complaint_controller "https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/backend/controllers/complaintController.js"
click node_priority_validation "https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/backend/constants/complaints.js"
click node_access "https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/backend/middleware/auth.js"
click node_users "https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/backend/models/User.js"
click node_complaints "https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/backend/models/Complaint.js"
click node_student_directory "https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/backend/routes/studentRoutes.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_student_ui,node_manager_ui,node_auth_ui,node_analytics_ui,node_service,node_auth_context,node_fetch toneBlue
class node_complaint_routes,node_auth_routes,node_student_routes,node_analytics_routes,node_server,node_access,node_mongo toneAmber
class node_auth_controller,node_complaint_controller,node_priority_validation,node_student_directory toneMint
class node_users,node_complaints toneRose
class node_student,node_manager toneIndigo
```

## Components

### Web application

- [Role-based routes](https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/frontend/src/App.jsx): `frontend/src/App.jsx`
- [Student workflows](https://github.com/utkarshdagur/hostel-complaint-tracker/tree/main/frontend/src/pages/student): `frontend/src/pages/student`
- [Manager workflows](https://github.com/utkarshdagur/hostel-complaint-tracker/tree/main/frontend/src/pages/manager): `frontend/src/pages/manager`
- [Login and profile](https://github.com/utkarshdagur/hostel-complaint-tracker/tree/main/frontend/src/pages/auth): `frontend/src/pages/auth`
- [Analytics views](https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/frontend/src/pages/manager/Analytics.jsx): `frontend/src/pages/manager/Analytics.jsx`
- [API and mock service](https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/frontend/src/services/api.js): `frontend/src/services/api.js`
- [Session state](https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/frontend/src/context/AuthContext.jsx): `frontend/src/context/AuthContext.jsx`
- [Data fetching](https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/frontend/src/hooks/useFetch.js): `frontend/src/hooks/useFetch.js`

### REST API

- [Complaint routes](https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/backend/routes/complaintRoutes.js): `backend/routes/complaintRoutes.js`
- [Authentication routes](https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/backend/routes/authRoutes.js): `backend/routes/authRoutes.js`
- [Student directory](https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/backend/routes/studentRoutes.js): `backend/routes/studentRoutes.js`
- [Analytics endpoints](https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/backend/routes/analyticsRoutes.js): `backend/routes/analyticsRoutes.js`
- [Express server](https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/backend/server.js): `backend/server.js`
- [Authentication and roles](https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/backend/middleware/auth.js): `backend/middleware/auth.js`

### Complaint operations

- [Account operations](https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/backend/controllers/authController.js): `backend/controllers/authController.js`
- [Complaint lifecycle](https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/backend/controllers/complaintController.js): `backend/controllers/complaintController.js`
- [Priority and validation](https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/backend/constants/complaints.js): `backend/constants/complaints.js`
- [Student statistics](https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/backend/routes/studentRoutes.js): `backend/routes/studentRoutes.js`

### Persistence

- [User records](https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/backend/models/User.js): `backend/models/User.js`
- [Complaint records](https://github.com/utkarshdagur/hostel-complaint-tracker/blob/main/backend/models/Complaint.js): `backend/models/Complaint.js`

### Other components

- **Student**
- **Manager**
- **MongoDB**

## Connections

- Student → Role-based routes: uses (evidence: `frontend/src/App.jsx`)
- Manager → Role-based routes: uses (evidence: `frontend/src/App.jsx`)
- Role-based routes → Student workflows: routes (evidence: `frontend/src/App.jsx`)
- Role-based routes → Manager workflows: routes (evidence: `frontend/src/App.jsx`)
- Role-based routes → Login and profile: routes (evidence: `frontend/src/App.jsx`)
- Student workflows → API and mock service: requests data (evidence: `frontend/src/pages/student/MyComplaints.jsx`)
- Manager workflows → API and mock service: requests data (evidence: `frontend/src/pages/manager/ManagerDashboard.jsx`)
- Manager workflows → Analytics views: routes (evidence: `frontend/src/App.jsx`)
- Analytics views → API and mock service: requests analytics (evidence: `README.md`)
- Login and profile → Session state: uses session (evidence: `frontend/src/context/AuthContext.jsx`)
- Student workflows → Data fetching: loads data (evidence: `frontend/src/pages/student/MyComplaints.jsx`)
- Manager workflows → Data fetching: loads data (evidence: `frontend/src/pages/manager/ManagerDashboard.jsx`)
- Data fetching → API and mock service: calls (evidence: `frontend/src/pages/manager/ManagerDashboard.jsx`)
- API and mock service → Express server: HTTP REST (evidence: `README.md`)
- API and mock service → Student workflows: mock responses (evidence: `README.md`)
- Express server → Complaint routes: mounts (evidence: `backend/server.js`)
- Express server → Authentication routes: mounts (evidence: `backend/server.js`)
- Express server → Student directory: mounts (evidence: `backend/server.js`)
- Express server → Analytics endpoints: mounts (evidence: `backend/server.js`)
- Authentication routes → Account operations: dispatches (evidence: `backend/routes/authRoutes.js`)
- Complaint routes → Authentication and roles: protects (evidence: `backend/routes/complaintRoutes.js`)
- Complaint routes → Complaint lifecycle: dispatches (evidence: `backend/routes/complaintRoutes.js`)
- Authentication routes → Authentication and roles: protects (evidence: `backend/routes/authRoutes.js`)
- Account operations → User records: reads/writes (evidence: `backend/controllers/authController.js`)
- Authentication and roles → User records: loads account (evidence: `backend/middleware/auth.js`)
- Complaint lifecycle → Complaint records: reads/writes (evidence: `backend/controllers/complaintController.js`)
- Complaint lifecycle → Priority and validation: derives priority (evidence: `backend/controllers/complaintController.js`)
- Student directory → User records: queries students (evidence: `backend/routes/studentRoutes.js`)
- Student directory → Complaint records: aggregates counts (evidence: `backend/routes/studentRoutes.js`)
- Analytics endpoints → Complaint records: queries analytics (evidence: `backend/routes/analyticsRoutes.js`)
- Analytics endpoints → User records: queries accounts (evidence: `backend/routes/analyticsRoutes.js`)
- User records → MongoDB: persists (evidence: `README.md`)
- Complaint records → MongoDB: persists (evidence: `README.md`)
- Manager → Student statistics: views directory (evidence: `README.md`)
- Student → Student workflows: submits and tracks (evidence: `README.md`)
- Manager → Manager workflows: triages complaints (evidence: `README.md`)
