# dharanidharanravikumar/elmquiz architecture

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

- Interactive diagram: https://gitdiagram.com/dharanidharanravikumar/elmquiz
- Repository: https://github.com/dharanidharanravikumar/elmquiz

## Overview

ELM Quiz digitizes a six-domain student self-assessment: users enter personal details, answer the question bank, and submit responses for scoring, interpretation, and report creation. They can then look up and download a personalized PDF; administrators also have a protected dashboard for report lookup and downloads. The frontend uses shared quiz and authentication state, while an Express API handles authentication and report operations backed by MongoDB. Some frontend-to-API links are documented capabilities rather than shown calls; those edges cite the README.

Main entry points: [`frontend/src/App.jsx`](https://github.com/dharanidharanravikumar/elmquiz/blob/master/frontend/src/App.jsx) (Route application), [`backend/routes/report.js`](https://github.com/dharanidharanravikumar/elmquiz/blob/master/backend/routes/report.js) (Report operations), [`frontend/src/pages/QuizPage.jsx`](https://github.com/dharanidharanravikumar/elmquiz/blob/master/frontend/src/pages/QuizPage.jsx) (Assessment quiz), [`frontend/src/pages/Login.jsx`](https://github.com/dharanidharanravikumar/elmquiz/blob/master/frontend/src/pages/Login.jsx) (Admin login)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_frontend["Assessment frontend"]
  node_app["Route application<br/>[App.jsx]"]
  node_home["Assessment home<br/>[Home.jsx]"]
  node_gender["Gender selection"]
  node_details["Personal details"]
  node_quiz["Assessment quiz<br/>[QuizPage.jsx]"]
  node_quizstate["Quiz state<br/>[QuizContext.jsx]"]
  node_questions["Question bank<br/>[questions.json]"]
end

subgraph group_access["Access and reports"]
  node_login["Admin login<br/>[Login.jsx]"]
  node_authstate["Authentication state<br/>[AuthContext.jsx]"]
  node_guard["Role guard<br/>[ProtectedRoute.jsx]"]
  node_admin["Admin dashboard<br/>[AdminDashboard.jsx]"]
  node_lookup["Report lookup<br/>[MyReport.jsx]"]
end

subgraph group_backend["API and persistence"]
  node_api["Express API<br/>[app.js]"]
  node_authroute["Admin authentication<br/>[auth.js]"]
  node_reportroute["Report operations<br/>[report.js]"]
  node_reportdb[("Report records<br/>[Report.js]")]
end

subgraph group_scoring["Scoring and reporting"]
  node_scoring["Domain scoring<br/>[scoringHelper.js]"]
  node_thresholds["Score interpretation"]
  node_pdf["PDF report<br/>[report.js]"]
end

node_student(("Student"))
node_administrator(("Administrator"))

node_student -->|"uses"| node_app
node_app -->|"routes to"| node_home
node_app -->|"routes to"| node_gender
node_app -->|"routes to"| node_details
node_app -->|"routes to"| node_quiz
node_app -->|"routes to"| node_login
node_app -->|"routes to"| node_admin
node_app -->|"routes to"| node_lookup
node_gender -->|"renders"| node_details
node_details -.->|"continues to"| node_quiz
node_quiz -->|"reads and updates"| node_quizstate
node_quizstate -->|"loads"| node_questions
node_quiz -->|"submits responses"| node_reportroute
node_login -->|"sets login state"| node_authstate
node_guard -->|"checks role"| node_authstate
node_app -->|"protects admin"| node_guard
node_administrator -->|"uses"| node_admin
node_login -.->|"authenticates"| node_authroute
node_admin -.->|"looks up and downloads"| node_reportroute
node_student -->|"requests report"| node_lookup
node_lookup -.->|"looks up and downloads"| node_reportroute
node_api -->|"mounts"| node_reportroute
node_api -->|"mounts"| node_authroute
node_reportroute -->|"calculates domains"| node_scoring
node_scoring -->|"classifies scores"| node_thresholds
node_reportroute -->|"saves and queries"| node_reportdb
node_reportroute -->|"generates download"| node_pdf

click node_app "https://github.com/dharanidharanravikumar/elmquiz/blob/master/frontend/src/App.jsx"
click node_home "https://github.com/dharanidharanravikumar/elmquiz/blob/master/frontend/src/pages/Home.jsx"
click node_gender "https://github.com/dharanidharanravikumar/elmquiz/blob/master/frontend/src/pages/GenderSelectionPage.jsx"
click node_details "https://github.com/dharanidharanravikumar/elmquiz/blob/master/frontend/src/pages/PersonalDetails.jsx"
click node_quiz "https://github.com/dharanidharanravikumar/elmquiz/blob/master/frontend/src/pages/QuizPage.jsx"
click node_quizstate "https://github.com/dharanidharanravikumar/elmquiz/blob/master/frontend/src/contexts/QuizContext.jsx"
click node_questions "https://github.com/dharanidharanravikumar/elmquiz/blob/master/frontend/src/data/questions.json"
click node_login "https://github.com/dharanidharanravikumar/elmquiz/blob/master/frontend/src/pages/Login.jsx"
click node_authstate "https://github.com/dharanidharanravikumar/elmquiz/blob/master/frontend/src/contexts/AuthContext.jsx"
click node_guard "https://github.com/dharanidharanravikumar/elmquiz/blob/master/frontend/src/components/ProtectedRoute.jsx"
click node_admin "https://github.com/dharanidharanravikumar/elmquiz/blob/master/frontend/src/pages/AdminDashboard.jsx"
click node_lookup "https://github.com/dharanidharanravikumar/elmquiz/blob/master/frontend/src/pages/MyReport.jsx"
click node_api "https://github.com/dharanidharanravikumar/elmquiz/blob/master/backend/app.js"
click node_authroute "https://github.com/dharanidharanravikumar/elmquiz/blob/master/backend/routes/auth.js"
click node_reportroute "https://github.com/dharanidharanravikumar/elmquiz/blob/master/backend/routes/report.js"
click node_scoring "https://github.com/dharanidharanravikumar/elmquiz/blob/master/backend/utils/scoringHelper.js"
click node_thresholds "https://github.com/dharanidharanravikumar/elmquiz/blob/master/backend/utils/determineScoreRange.js"
click node_reportdb "https://github.com/dharanidharanravikumar/elmquiz/blob/master/backend/models/Report.js"
click node_pdf "https://github.com/dharanidharanravikumar/elmquiz/blob/master/backend/routes/report.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_home,node_gender,node_details,node_quiz,node_quizstate,node_questions toneBlue
class node_login,node_authstate,node_guard,node_admin,node_lookup toneAmber
class node_api,node_authroute,node_reportroute,node_reportdb toneMint
class node_scoring,node_thresholds,node_pdf toneRose
class node_student,node_administrator toneIndigo
```

## Components

### Assessment frontend

- [Route application](https://github.com/dharanidharanravikumar/elmquiz/blob/master/frontend/src/App.jsx): `frontend/src/App.jsx`
- [Assessment home](https://github.com/dharanidharanravikumar/elmquiz/blob/master/frontend/src/pages/Home.jsx): `frontend/src/pages/Home.jsx`
- [Gender selection](https://github.com/dharanidharanravikumar/elmquiz/blob/master/frontend/src/pages/GenderSelectionPage.jsx): `frontend/src/pages/GenderSelectionPage.jsx`
- [Personal details](https://github.com/dharanidharanravikumar/elmquiz/blob/master/frontend/src/pages/PersonalDetails.jsx): `frontend/src/pages/PersonalDetails.jsx`
- [Assessment quiz](https://github.com/dharanidharanravikumar/elmquiz/blob/master/frontend/src/pages/QuizPage.jsx): `frontend/src/pages/QuizPage.jsx`
- [Quiz state](https://github.com/dharanidharanravikumar/elmquiz/blob/master/frontend/src/contexts/QuizContext.jsx): `frontend/src/contexts/QuizContext.jsx`
- [Question bank](https://github.com/dharanidharanravikumar/elmquiz/blob/master/frontend/src/data/questions.json): `frontend/src/data/questions.json`

### Access and reports

- [Admin login](https://github.com/dharanidharanravikumar/elmquiz/blob/master/frontend/src/pages/Login.jsx): `frontend/src/pages/Login.jsx`
- [Authentication state](https://github.com/dharanidharanravikumar/elmquiz/blob/master/frontend/src/contexts/AuthContext.jsx): `frontend/src/contexts/AuthContext.jsx`
- [Role guard](https://github.com/dharanidharanravikumar/elmquiz/blob/master/frontend/src/components/ProtectedRoute.jsx): `frontend/src/components/ProtectedRoute.jsx`
- [Admin dashboard](https://github.com/dharanidharanravikumar/elmquiz/blob/master/frontend/src/pages/AdminDashboard.jsx): `frontend/src/pages/AdminDashboard.jsx`
- [Report lookup](https://github.com/dharanidharanravikumar/elmquiz/blob/master/frontend/src/pages/MyReport.jsx): `frontend/src/pages/MyReport.jsx`

### API and persistence

- [Express API](https://github.com/dharanidharanravikumar/elmquiz/blob/master/backend/app.js): `backend/app.js`
- [Admin authentication](https://github.com/dharanidharanravikumar/elmquiz/blob/master/backend/routes/auth.js): `backend/routes/auth.js`
- [Report operations](https://github.com/dharanidharanravikumar/elmquiz/blob/master/backend/routes/report.js): `backend/routes/report.js`
- [Report records](https://github.com/dharanidharanravikumar/elmquiz/blob/master/backend/models/Report.js): `backend/models/Report.js`

### Scoring and reporting

- [Domain scoring](https://github.com/dharanidharanravikumar/elmquiz/blob/master/backend/utils/scoringHelper.js): `backend/utils/scoringHelper.js`
- [Score interpretation](https://github.com/dharanidharanravikumar/elmquiz/blob/master/backend/utils/determineScoreRange.js): `backend/utils/determineScoreRange.js`
- [PDF report](https://github.com/dharanidharanravikumar/elmquiz/blob/master/backend/routes/report.js): `backend/routes/report.js`

### Other components

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

## Connections

- Student → Route application: uses (evidence: `Readme.md`)
- Route application → Assessment home: routes to (evidence: `frontend/src/App.jsx`)
- Route application → Gender selection: routes to (evidence: `frontend/src/App.jsx`)
- Route application → Personal details: routes to (evidence: `frontend/src/App.jsx`)
- Route application → Assessment quiz: routes to (evidence: `frontend/src/App.jsx`)
- Route application → Admin login: routes to (evidence: `frontend/src/App.jsx`)
- Route application → Admin dashboard: routes to (evidence: `frontend/src/App.jsx`)
- Route application → Report lookup: routes to (evidence: `frontend/src/App.jsx`)
- Gender selection → Personal details: renders (evidence: `frontend/src/pages/GenderSelectionPage.jsx`)
- Personal details → Assessment quiz: continues to (evidence: `Readme.md`)
- Assessment quiz → Quiz state: reads and updates (evidence: `frontend/src/pages/QuizPage.jsx`)
- Quiz state → Question bank: loads (evidence: `frontend/src/contexts/QuizContext.jsx`)
- Assessment quiz → Report operations: submits responses (evidence: `frontend/src/pages/QuizPage.jsx`)
- Admin login → Authentication state: sets login state (evidence: `frontend/src/pages/Login.jsx`)
- Role guard → Authentication state: checks role (evidence: `frontend/src/components/ProtectedRoute.jsx`)
- Route application → Role guard: protects admin (evidence: `frontend/src/App.jsx`)
- Administrator → Admin dashboard: uses (evidence: `Readme.md`)
- Admin login → Admin authentication: authenticates (evidence: `Readme.md`)
- Admin dashboard → Report operations: looks up and downloads (evidence: `Readme.md`)
- Student → Report lookup: requests report (evidence: `Readme.md`)
- Report lookup → Report operations: looks up and downloads (evidence: `Readme.md`)
- Express API → Report operations: mounts (evidence: `backend/app.js`)
- Express API → Admin authentication: mounts (evidence: `backend/app.js`)
- Report operations → Domain scoring: calculates domains (evidence: `backend/routes/report.js`)
- Domain scoring → Score interpretation: classifies scores (evidence: `backend/utils/scoringHelper.js`)
- Report operations → Report records: saves and queries (evidence: `backend/routes/report.js`)
- Report operations → PDF report: generates download (evidence: `backend/routes/report.js`)
