# vyshnavi536/eduseal1 architecture

> Architecture diagram of the GitHub repository vyshnavi536/eduseal1, 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/vyshnavi536/eduseal1
- Repository: https://github.com/vyshnavi536/eduseal1

## Overview

Eduseal Tutor is an exam-preparation app for JEE/NEET learners. Users sign in, choose a test, answer timed questions, submit for evaluation, and review results and progress; they can also ask AI-powered study questions. The frontend uses Firebase for authentication and user/test data, while an Express backend provides question and AI endpoints. The excerpts show the question and AI service flows; some frontend-to-backend HTTP wiring and unsampled progress and settings behavior are represented only where clearly supported or left unverified.

Main entry points: [`frontend/src/App.jsx`](https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/App.jsx) (App routing), [`frontend/src/pages/TestPage.jsx`](https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/pages/TestPage.jsx) (Timed test), [`frontend/src/firebase.js`](https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/firebase.js) (Firebase client), [`backend/src/routes/aiRoutes.js`](https://github.com/vyshnavi536/eduseal1/blob/main/backend/src/routes/aiRoutes.js) (AI endpoint)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_learner["Learner experience"]
  node_app["App routing<br/>[App.jsx]"]
  node_authpages["Sign in and signup<br/>[Login.jsx]"]
  node_guard["Protected routes<br/>[ProtectedRoute.jsx]"]
  node_home["Study home<br/>[Home.jsx]"]
  node_navbar["Profile and settings<br/>[Navbar.jsx]"]
end

subgraph group_exam["Practice and progress"]
  node_testsetup["Test setup<br/>[TakeTest.jsx]"]
  node_testpage["Timed test<br/>[TestPage.jsx]"]
  node_questionui["Question controls<br/>[QuestionCard.jsx]"]
  node_navigator["Question navigation"]
  node_questionbank["Local question bank<br/>[questionBank.js]"]
  node_summary["Test summary<br/>[TestSummary.jsx]"]
  node_progress["Progress tracking<br/>[Progress.jsx]"]
  node_doubts["Ask a doubt<br/>[AskDoubt.jsx]"]
end

subgraph group_api["Backend API"]
  node_api_client["API client<br/>[api.js]"]
  node_server["Express server<br/>[server.js]"]
  node_questionroutes["Question endpoints<br/>[questionRoutes.js]"]
  node_questionservice["Question selection and scoring<br/>[questionService.js]"]
  node_airoutes["AI endpoint<br/>[aiRoutes.js]"]
  node_groq["Groq AI service<br/>[groqService.js]"]
  node_usage["AI usage limits<br/>[usageService.js]"]
  node_backend_errors["Error handlers<br/>[errorHandler.js]"]
end

subgraph group_platform["Identity and data"]
  node_authmw["Request authentication<br/>[requireAuth.js]"]
  node_firebaseadmin["Admin identity<br/>[firebaseAdmin.js]"]
  node_firebaseclient["Firebase client<br/>[firebase.js]"]
  node_mysqlconfig["Database access<br/>[database.js]"]
  node_mysql[("MySQL question store")]
  node_firestore[("Firestore user data")]
end

node_learner(("Learner"))
node_groqext{{"Groq service"}}

node_learner -->|"uses"| node_app
node_app -->|"routes to"| node_authpages
node_app -->|"protects"| node_guard
node_app -->|"routes to"| node_home
node_app -->|"routes to"| node_testsetup
node_app -->|"routes to"| node_testpage
node_app -->|"routes to"| node_summary
node_app -->|"routes to"| node_progress
node_app -->|"routes to"| node_doubts
node_guard -->|"checks session"| node_firebaseclient
node_authpages -->|"uses identity"| node_firebaseclient
node_home -->|"renders"| node_navbar
node_navbar -->|"reads profile"| node_firebaseclient
node_navbar -->|"reads and writes"| node_firestore
node_testsetup -->|"uses identity"| node_firebaseclient
node_testpage -->|"requests test and scoring"| node_api_client
node_testpage -->|"renders"| node_questionui
node_testpage -->|"renders"| node_navigator
node_testpage -->|"falls back to"| node_questionbank
node_testpage -->|"uses identity"| node_firebaseclient
node_testpage -->|"saves test result"| node_firestore
node_progress -->|"uses data access"| node_firebaseclient
node_progress -.->|"reads progress"| node_firestore
node_doubts -.->|"requests answer"| node_api_client
node_api_client -.->|"calls endpoints"| node_questionroutes
node_api_client -.->|"calls endpoint"| node_airoutes
node_server -->|"mounts routes"| node_questionroutes
node_server -->|"mounts routes"| node_airoutes
node_server -->|"uses handlers"| node_backend_errors
node_questionroutes -->|"calls"| node_questionservice
node_questionroutes -->|"requires auth"| node_authmw
node_questionservice -->|"queries"| node_mysqlconfig
node_mysqlconfig -->|"executes SQL"| node_mysql
node_airoutes -->|"requires auth"| node_authmw
node_airoutes -->|"checks quota and lock"| node_usage
node_airoutes -->|"requests response"| node_groq
node_groq -.->|"calls provider"| node_groqext
node_usage -->|"uses admin identity"| node_firebaseadmin
node_authmw -->|"verifies token"| node_firebaseadmin
node_firebaseclient -->|"connects"| node_firestore

click node_app "https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/App.jsx"
click node_authpages "https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/pages/Login.jsx"
click node_guard "https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/components/ProtectedRoute.jsx"
click node_home "https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/pages/Home.jsx"
click node_navbar "https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/components/Navbar.jsx"
click node_testsetup "https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/pages/TakeTest.jsx"
click node_testpage "https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/pages/TestPage.jsx"
click node_questionui "https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/components/QuestionCard.jsx"
click node_navigator "https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/components/QuestionNavigator.jsx"
click node_questionbank "https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/data/questionBank.js"
click node_summary "https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/pages/TestSummary.jsx"
click node_progress "https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/pages/Progress.jsx"
click node_doubts "https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/pages/AskDoubt.jsx"
click node_api_client "https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/services/api.js"
click node_server "https://github.com/vyshnavi536/eduseal1/blob/main/backend/src/server.js"
click node_questionroutes "https://github.com/vyshnavi536/eduseal1/blob/main/backend/src/routes/questionRoutes.js"
click node_questionservice "https://github.com/vyshnavi536/eduseal1/blob/main/backend/src/services/questionService.js"
click node_airoutes "https://github.com/vyshnavi536/eduseal1/blob/main/backend/src/routes/aiRoutes.js"
click node_groq "https://github.com/vyshnavi536/eduseal1/blob/main/backend/src/services/groqService.js"
click node_usage "https://github.com/vyshnavi536/eduseal1/blob/main/backend/src/services/usageService.js"
click node_backend_errors "https://github.com/vyshnavi536/eduseal1/blob/main/backend/src/middleware/errorHandler.js"
click node_authmw "https://github.com/vyshnavi536/eduseal1/blob/main/backend/src/middleware/requireAuth.js"
click node_firebaseadmin "https://github.com/vyshnavi536/eduseal1/blob/main/backend/src/config/firebaseAdmin.js"
click node_firebaseclient "https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/firebase.js"
click node_mysqlconfig "https://github.com/vyshnavi536/eduseal1/blob/main/backend/src/config/database.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_authpages,node_guard,node_home,node_navbar toneBlue
class node_testsetup,node_testpage,node_questionui,node_navigator,node_questionbank,node_summary,node_progress,node_doubts toneAmber
class node_api_client,node_server,node_questionroutes,node_questionservice,node_airoutes,node_groq,node_usage,node_backend_errors toneMint
class node_authmw,node_firebaseadmin,node_firebaseclient,node_mysqlconfig,node_mysql,node_firestore toneRose
class node_learner,node_groqext toneIndigo
```

## Components

### Learner experience

- [App routing](https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/App.jsx): `frontend/src/App.jsx`
- [Sign in and signup](https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/pages/Login.jsx): `frontend/src/pages/Login.jsx`
- [Protected routes](https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/components/ProtectedRoute.jsx): `frontend/src/components/ProtectedRoute.jsx`
- [Study home](https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/pages/Home.jsx): `frontend/src/pages/Home.jsx`
- [Profile and settings](https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/components/Navbar.jsx): `frontend/src/components/Navbar.jsx`

### Practice and progress

- [Test setup](https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/pages/TakeTest.jsx): `frontend/src/pages/TakeTest.jsx`
- [Timed test](https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/pages/TestPage.jsx): `frontend/src/pages/TestPage.jsx`
- [Question controls](https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/components/QuestionCard.jsx): `frontend/src/components/QuestionCard.jsx`
- [Question navigation](https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/components/QuestionNavigator.jsx): `frontend/src/components/QuestionNavigator.jsx`
- [Local question bank](https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/data/questionBank.js): `frontend/src/data/questionBank.js`
- [Test summary](https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/pages/TestSummary.jsx): `frontend/src/pages/TestSummary.jsx`
- [Progress tracking](https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/pages/Progress.jsx): `frontend/src/pages/Progress.jsx`
- [Ask a doubt](https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/pages/AskDoubt.jsx): `frontend/src/pages/AskDoubt.jsx`

### Backend API

- [API client](https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/services/api.js): `frontend/src/services/api.js`
- [Express server](https://github.com/vyshnavi536/eduseal1/blob/main/backend/src/server.js): `backend/src/server.js`
- [Question endpoints](https://github.com/vyshnavi536/eduseal1/blob/main/backend/src/routes/questionRoutes.js): `backend/src/routes/questionRoutes.js`
- [Question selection and scoring](https://github.com/vyshnavi536/eduseal1/blob/main/backend/src/services/questionService.js): `backend/src/services/questionService.js`
- [AI endpoint](https://github.com/vyshnavi536/eduseal1/blob/main/backend/src/routes/aiRoutes.js): `backend/src/routes/aiRoutes.js`
- [Groq AI service](https://github.com/vyshnavi536/eduseal1/blob/main/backend/src/services/groqService.js): `backend/src/services/groqService.js`
- [AI usage limits](https://github.com/vyshnavi536/eduseal1/blob/main/backend/src/services/usageService.js): `backend/src/services/usageService.js`
- [Error handlers](https://github.com/vyshnavi536/eduseal1/blob/main/backend/src/middleware/errorHandler.js): `backend/src/middleware/errorHandler.js`

### Identity and data

- [Request authentication](https://github.com/vyshnavi536/eduseal1/blob/main/backend/src/middleware/requireAuth.js): `backend/src/middleware/requireAuth.js`
- [Admin identity](https://github.com/vyshnavi536/eduseal1/blob/main/backend/src/config/firebaseAdmin.js): `backend/src/config/firebaseAdmin.js`
- [Firebase client](https://github.com/vyshnavi536/eduseal1/blob/main/frontend/src/firebase.js): `frontend/src/firebase.js`
- [Database access](https://github.com/vyshnavi536/eduseal1/blob/main/backend/src/config/database.js): `backend/src/config/database.js`
- **MySQL question store**
- **Firestore user data**

### Other components

- **Learner**
- **Groq service**

## Connections

- Learner → App routing: uses (evidence: `frontend/src/App.jsx`)
- App routing → Sign in and signup: routes to (evidence: `frontend/src/App.jsx`)
- App routing → Protected routes: protects (evidence: `frontend/src/App.jsx`)
- App routing → Study home: routes to (evidence: `frontend/src/App.jsx`)
- App routing → Test setup: routes to (evidence: `frontend/src/App.jsx`)
- App routing → Timed test: routes to (evidence: `frontend/src/App.jsx`)
- App routing → Test summary: routes to (evidence: `frontend/src/App.jsx`)
- App routing → Progress tracking: routes to (evidence: `frontend/src/App.jsx`)
- App routing → Ask a doubt: routes to (evidence: `frontend/src/App.jsx`)
- Protected routes → Firebase client: checks session (evidence: `frontend/src/components/ProtectedRoute.jsx`)
- Sign in and signup → Firebase client: uses identity (evidence: `frontend/src/pages/Login.jsx`)
- Study home → Profile and settings: renders (evidence: `frontend/src/pages/Home.jsx`)
- Profile and settings → Firebase client: reads profile (evidence: `frontend/src/components/Navbar.jsx`)
- Profile and settings → Firestore user data: reads and writes (evidence: `frontend/src/components/Navbar.jsx`)
- Test setup → Firebase client: uses identity (evidence: `frontend/src/pages/TakeTest.jsx`)
- Timed test → API client: requests test and scoring (evidence: `frontend/src/pages/TestPage.jsx`)
- Timed test → Question controls: renders (evidence: `frontend/src/pages/TestPage.jsx`)
- Timed test → Question navigation: renders (evidence: `frontend/src/pages/TestPage.jsx`)
- Timed test → Local question bank: falls back to (evidence: `frontend/src/pages/TestPage.jsx`)
- Timed test → Firebase client: uses identity (evidence: `frontend/src/pages/TestPage.jsx`)
- Timed test → Firestore user data: saves test result (evidence: `frontend/src/pages/TestPage.jsx`)
- Progress tracking → Firebase client: uses data access (evidence: `frontend/src/pages/Progress.jsx`)
- Progress tracking → Firestore user data: reads progress
- Ask a doubt → API client: requests answer
- API client → Question endpoints: calls endpoints
- API client → AI endpoint: calls endpoint
- Express server → Question endpoints: mounts routes (evidence: `backend/src/server.js`)
- Express server → AI endpoint: mounts routes (evidence: `backend/src/server.js`)
- Express server → Error handlers: uses handlers (evidence: `backend/src/server.js`)
- Question endpoints → Question selection and scoring: calls (evidence: `backend/src/routes/questionRoutes.js`)
- Question endpoints → Request authentication: requires auth (evidence: `backend/src/routes/questionRoutes.js`)
- Question selection and scoring → Database access: queries (evidence: `backend/src/services/questionService.js`)
- Database access → MySQL question store: executes SQL (evidence: `backend/src/config/database.js`)
- AI endpoint → Request authentication: requires auth (evidence: `backend/src/routes/aiRoutes.js`)
- AI endpoint → AI usage limits: checks quota and lock (evidence: `backend/src/routes/aiRoutes.js`)
- AI endpoint → Groq AI service: requests response (evidence: `backend/src/routes/aiRoutes.js`)
- Groq AI service → Groq service: calls provider
- AI usage limits → Admin identity: uses admin identity (evidence: `backend/src/services/usageService.js`)
- Request authentication → Admin identity: verifies token (evidence: `backend/src/middleware/requireAuth.js`)
- Firebase client → Firestore user data: connects (evidence: `frontend/src/firebase.js`)
