# haribalaji96/eduvault architecture

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

## Overview

EduVault is a role-based education platform for administrators, teachers, and students. Users enter through the routed frontend, authenticate, then work with school administration, classrooms, assessments, or coding practice. The assessment workflow spans teacher authoring and publishing, student attempts and answers, and teacher review; classroom workflows cover enrollment, posts, and assignment submissions. The map preserves documented-by-routes capabilities where implementation excerpts are absent; those links are dashed when their exact runtime wiring is not shown.

Main entry points: [`frontend/src/App.tsx`](https://github.com/haribalaji96/eduvault/blob/main/frontend/src/App.tsx) (Role-based routes), [`frontend/src/api/client.ts`](https://github.com/haribalaji96/eduvault/blob/main/frontend/src/api/client.ts) (API client), [`frontend/src/pages/teacher`](https://github.com/haribalaji96/eduvault/tree/main/frontend/src/pages/teacher) (Teacher screens), [`backend/src/main/java/com/psgtech/eduvault/service/ClassroomService.java`](https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/service/ClassroomService.java) (Classroom operations)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_front["Web application"]
  node_routes["Role-based routes<br/>[App.tsx]"]
  node_api["API client<br/>[client.ts]"]
end

subgraph group_identity["Identity and access"]
  node_authui["Auth state<br/>[AuthContext.tsx]"]
  node_authctl["Authentication API"]
  node_authsecurity["JWT security"]
end

subgraph group_admin["School administration"]
  node_adminpages["Admin screens"]
  node_adminctl["Admin API"]
end

subgraph group_classroom["Classrooms"]
  node_teacherpages["Teacher screens"]
  node_classctl["Teacher classroom API"]
  node_classsvc["Classroom operations"]
end

subgraph group_assessment["Assessments and practice"]
  node_studentpages["Student screens"]
  node_assessui["Assessment API<br/>[assessmentApi.ts]"]
  node_teachsvc["Assessment authoring"]
  node_studentsvc["Assessment attempts"]
  node_practice["Coding practice"]
end

subgraph group_backend["Backend services"]
  node_adminsvc["User administration"]
  node_execution["Code execution"]
  node_files["File handling"]
  node_classdata[("Classroom records<br/>[Classroom.java]")]
  node_userrecord[("User records<br/>[User.java]")]
  node_classrepo["Classroom repository"]
  node_userrepo["User repository"]
  node_assessmentdata[("Assessment records<br/>[Assessment.java]")]
  node_submissiondata[("Submission records<br/>[Submission.java]")]
end

node_actors(("Admin · Teacher · Student"))

node_actors -->|"use roles"| node_routes
node_routes -->|"wraps routes"| node_authui
node_routes -->|"routes admin"| node_adminpages
node_routes -->|"routes teacher"| node_teacherpages
node_routes -->|"routes student"| node_studentpages
node_authui -.->|"stores credentials"| node_api
node_adminpages -.->|"calls API"| node_api
node_teacherpages -.->|"calls API"| node_api
node_teacherpages -->|"uses assessment API"| node_assessui
node_studentpages -.->|"uses assessment API"| node_assessui
node_api -.->|"HTTP requests"| node_adminctl
node_api -.->|"HTTP requests"| node_classctl
node_assessui -.->|"HTTP requests"| node_teachsvc
node_adminctl -->|"delegates"| node_adminsvc
node_adminctl -->|"delegates"| node_classsvc
node_classctl -->|"delegates"| node_classsvc
node_classsvc -->|"reads records"| node_classrepo
node_classsvc -->|"looks up users"| node_userrepo
node_adminsvc -->|"saves users"| node_userrepo
node_authctl -.->|"issues credentials"| node_authsecurity
node_authsecurity -->|"loads identity"| node_userrepo
node_teachsvc -->|"manages assessments"| node_assessmentdata
node_studentsvc -.->|"creates attempts"| node_submissiondata
node_studentsvc -.->|"runs submitted code"| node_execution
node_practice -.->|"delegates execution"| node_execution
node_classdata -.->|"persisted through"| node_classrepo
node_userrecord -.->|"persisted through"| node_userrepo
node_teacherpages -.->|"uploads files"| node_files

click node_routes "https://github.com/haribalaji96/eduvault/blob/main/frontend/src/App.tsx"
click node_authui "https://github.com/haribalaji96/eduvault/blob/main/frontend/src/context/AuthContext.tsx"
click node_api "https://github.com/haribalaji96/eduvault/blob/main/frontend/src/api/client.ts"
click node_adminpages "https://github.com/haribalaji96/eduvault/tree/main/frontend/src/pages/admin"
click node_teacherpages "https://github.com/haribalaji96/eduvault/tree/main/frontend/src/pages/teacher"
click node_studentpages "https://github.com/haribalaji96/eduvault/tree/main/frontend/src/pages/student"
click node_assessui "https://github.com/haribalaji96/eduvault/blob/main/frontend/src/services/assessmentApi.ts"
click node_adminctl "https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/controller/AdminController.java"
click node_classctl "https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/controller/ClassroomController.java"
click node_adminsvc "https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/service/StudentService.java"
click node_classsvc "https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/service/ClassroomService.java"
click node_teachsvc "https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/service/AssessmentTeacherService.java"
click node_studentsvc "https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/service/AssessmentStudentService.java"
click node_authctl "https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/controller/AuthController.java"
click node_authsecurity "https://github.com/haribalaji96/eduvault/tree/main/backend/src/main/java/com/psgtech/eduvault/security"
click node_practice "https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/controller/PracticeController.java"
click node_execution "https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/service/CodeExecutionService.java"
click node_files "https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/service/FileStorageService.java"
click node_classdata "https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/entity/Classroom.java"
click node_userrecord "https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/entity/User.java"
click node_classrepo "https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/repository/ClassroomRepository.java"
click node_userrepo "https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/repository/UserRepository.java"
click node_assessmentdata "https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/entity/Assessment.java"
click node_submissiondata "https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/entity/Submission.java"

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_routes,node_api toneBlue
class node_authui,node_authctl,node_authsecurity toneAmber
class node_adminpages,node_adminctl toneMint
class node_teacherpages,node_classctl,node_classsvc toneRose
class node_studentpages,node_assessui,node_teachsvc,node_studentsvc,node_practice,node_actors toneIndigo
class node_adminsvc,node_execution,node_files,node_classdata,node_userrecord,node_classrepo,node_userrepo,node_assessmentdata,node_submissiondata toneTeal
```

## Components

### Web application

- [Role-based routes](https://github.com/haribalaji96/eduvault/blob/main/frontend/src/App.tsx): `frontend/src/App.tsx`
- [API client](https://github.com/haribalaji96/eduvault/blob/main/frontend/src/api/client.ts): `frontend/src/api/client.ts`

### Identity and access

- [Auth state](https://github.com/haribalaji96/eduvault/blob/main/frontend/src/context/AuthContext.tsx): `frontend/src/context/AuthContext.tsx`
- [Authentication API](https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/controller/AuthController.java): `backend/src/main/java/com/psgtech/eduvault/controller/AuthController.java`
- [JWT security](https://github.com/haribalaji96/eduvault/tree/main/backend/src/main/java/com/psgtech/eduvault/security): `backend/src/main/java/com/psgtech/eduvault/security`

### School administration

- [Admin screens](https://github.com/haribalaji96/eduvault/tree/main/frontend/src/pages/admin): `frontend/src/pages/admin`
- [Admin API](https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/controller/AdminController.java): `backend/src/main/java/com/psgtech/eduvault/controller/AdminController.java`

### Classrooms

- [Teacher screens](https://github.com/haribalaji96/eduvault/tree/main/frontend/src/pages/teacher): `frontend/src/pages/teacher`
- [Teacher classroom API](https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/controller/ClassroomController.java): `backend/src/main/java/com/psgtech/eduvault/controller/ClassroomController.java`
- [Classroom operations](https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/service/ClassroomService.java): `backend/src/main/java/com/psgtech/eduvault/service/ClassroomService.java`

### Assessments and practice

- [Student screens](https://github.com/haribalaji96/eduvault/tree/main/frontend/src/pages/student): `frontend/src/pages/student`
- [Assessment API](https://github.com/haribalaji96/eduvault/blob/main/frontend/src/services/assessmentApi.ts): `frontend/src/services/assessmentApi.ts`
- [Assessment authoring](https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/service/AssessmentTeacherService.java): `backend/src/main/java/com/psgtech/eduvault/service/AssessmentTeacherService.java`
- [Assessment attempts](https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/service/AssessmentStudentService.java): `backend/src/main/java/com/psgtech/eduvault/service/AssessmentStudentService.java`
- [Coding practice](https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/controller/PracticeController.java): `backend/src/main/java/com/psgtech/eduvault/controller/PracticeController.java`

### Backend services

- [User administration](https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/service/StudentService.java): `backend/src/main/java/com/psgtech/eduvault/service/StudentService.java`
- [Code execution](https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/service/CodeExecutionService.java): `backend/src/main/java/com/psgtech/eduvault/service/CodeExecutionService.java`
- [File handling](https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/service/FileStorageService.java): `backend/src/main/java/com/psgtech/eduvault/service/FileStorageService.java`
- [Classroom records](https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/entity/Classroom.java): `backend/src/main/java/com/psgtech/eduvault/entity/Classroom.java`
- [User records](https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/entity/User.java): `backend/src/main/java/com/psgtech/eduvault/entity/User.java`
- [Classroom repository](https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/repository/ClassroomRepository.java): `backend/src/main/java/com/psgtech/eduvault/repository/ClassroomRepository.java`
- [User repository](https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/repository/UserRepository.java): `backend/src/main/java/com/psgtech/eduvault/repository/UserRepository.java`
- [Assessment records](https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/entity/Assessment.java): `backend/src/main/java/com/psgtech/eduvault/entity/Assessment.java`
- [Submission records](https://github.com/haribalaji96/eduvault/blob/main/backend/src/main/java/com/psgtech/eduvault/entity/Submission.java): `backend/src/main/java/com/psgtech/eduvault/entity/Submission.java`

### Other components

- **Admin · Teacher · Student**

## Connections

- Admin · Teacher · Student → Role-based routes: use roles (evidence: `frontend/src/App.tsx`)
- Role-based routes → Auth state: wraps routes (evidence: `frontend/src/App.tsx`)
- Role-based routes → Admin screens: routes admin (evidence: `frontend/src/App.tsx`)
- Role-based routes → Teacher screens: routes teacher (evidence: `frontend/src/App.tsx`)
- Role-based routes → Student screens: routes student (evidence: `frontend/src/App.tsx`)
- Auth state → API client: stores credentials
- Admin screens → API client: calls API (evidence: `frontend/src/pages/admin/StudentManagement.tsx`)
- Teacher screens → API client: calls API (evidence: `frontend/src/pages/teacher/ClassroomDetail.tsx`)
- Teacher screens → Assessment API: uses assessment API (evidence: `frontend/src/pages/teacher/ClassroomDetail.tsx`)
- Student screens → Assessment API: uses assessment API
- API client → Admin API: HTTP requests
- API client → Teacher classroom API: HTTP requests
- Assessment API → Assessment authoring: HTTP requests
- Admin API → User administration: delegates (evidence: `backend/src/main/java/com/psgtech/eduvault/controller/AdminController.java`)
- Admin API → Classroom operations: delegates (evidence: `backend/src/main/java/com/psgtech/eduvault/controller/AdminController.java`)
- Teacher classroom API → Classroom operations: delegates (evidence: `backend/src/main/java/com/psgtech/eduvault/controller/ClassroomController.java`)
- Classroom operations → Classroom repository: reads records (evidence: `backend/src/main/java/com/psgtech/eduvault/service/ClassroomService.java`)
- Classroom operations → User repository: looks up users (evidence: `backend/src/main/java/com/psgtech/eduvault/service/ClassroomService.java`)
- User administration → User repository: saves users (evidence: `backend/src/main/java/com/psgtech/eduvault/service/StudentService.java`)
- Authentication API → JWT security: issues credentials
- JWT security → User repository: loads identity (evidence: `backend/src/main/java/com/psgtech/eduvault/security/CustomUserDetailsService.java`)
- Assessment authoring → Assessment records: manages assessments (evidence: `backend/src/main/java/com/psgtech/eduvault/service/AssessmentTeacherService.java`)
- Assessment attempts → Submission records: creates attempts (evidence: `backend/src/main/java/com/psgtech/eduvault/service/AssessmentStudentService.java`)
- Assessment attempts → Code execution: runs submitted code (evidence: `backend/src/main/java/com/psgtech/eduvault/service/AssessmentStudentService.java`)
- Coding practice → Code execution: delegates execution
- Classroom records → Classroom repository: persisted through (evidence: `backend/src/main/java/com/psgtech/eduvault/repository/ClassroomRepository.java`)
- User records → User repository: persisted through (evidence: `backend/src/main/java/com/psgtech/eduvault/repository/UserRepository.java`)
- Teacher screens → File handling: uploads files
