# chiragkewlani01/safeexam-platform architecture

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

- Interactive diagram: https://gitdiagram.com/chiragkewlani01/safeexam-platform
- Repository: https://github.com/chiragkewlani01/safeexam-platform

## Overview

SafeExam is an online exam platform for students and educators. Educators create exams and questions; students join by code, retrieve questions, submit answers, and receive a score. The sampled implementation shows a simpler MCQ flow than the README’s broader product description. The README also documents monitoring, coding exams, AI question generation, and educator reporting, but their implementation files are absent from this tree; those capabilities are shown at the available API-directory level, with documented relationships marked accordingly.

Main entry points: [`server/app/api/exams.py`](https://github.com/chiragkewlani01/safeexam-platform/blob/main/server/app/api/exams.py) (Exam endpoints), [`server/app/api/auth.py`](https://github.com/chiragkewlani01/safeexam-platform/blob/main/server/app/api/auth.py) (Auth endpoints), [`server/app/main.py`](https://github.com/chiragkewlani01/safeexam-platform/blob/main/server/app/main.py) (FastAPI app), [`server/app/core/database.py`](https://github.com/chiragkewlani01/safeexam-platform/blob/main/server/app/core/database.py) (Database access)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["Web client"]
  node_admin_ui["Educator exam form<br/>[CreateExamForm.tsx]"]
  node_admin_dashboard["Educator dashboard<br/>[DashboardAdmin.tsx]"]
  node_student_dashboard["Student dashboard"]
  node_join_form["Join exam form<br/>[JoinExamForm.tsx]"]
  node_navbar["Navigation<br/>[Navbar.tsx]"]
  node_auth_state["Auth state<br/>[useAuthStore.ts]"]
  node_api_client["API client<br/>[api.ts]"]
end

subgraph group_auth["Identity"]
  node_auth_api["Auth endpoints<br/>[auth.py]"]
  node_user_model["User records<br/>[user.py]"]
end

subgraph group_exam["Exam workflow"]
  node_exam_api["Exam endpoints<br/>[exams.py]"]
  node_exam_form_schema["Exam schemas<br/>[exam.py]"]
  node_exam_model["Exam records<br/>[exam.py]"]
  node_question_model["Question records<br/>[question.py]"]
end

subgraph group_backend["API and persistence"]
  node_db[("Database access<br/>[database.py]")]
  node_app_entry["FastAPI app<br/>[main.py]"]
end

subgraph group_extended["Documented capabilities"]
  node_monitoring["Integrity monitoring"]
  node_coding["Coding exams"]
  node_qie["AI question generation"]
  node_educator_reports["Reports and analytics"]
end

node_browser(("Browser user"))
node_google["Google OAuth"]
node_judge0["Judge0 execution"]
node_ai_provider["Gemini / OpenRouter"]

node_browser -->|"creates exam"| node_admin_ui
node_browser -->|"joins exam"| node_join_form
node_admin_ui -.->|"creates exam"| node_exam_api
node_join_form -.->|"joins by code"| node_exam_api
node_student_dashboard -.->|"views exams"| node_exam_api
node_admin_dashboard -.->|"manages exams"| node_exam_api
node_navbar -->|"reads session"| node_auth_state
node_navbar -.->|"logs out"| node_auth_api
node_api_client -.->|"sends requests"| node_exam_api
node_api_client -.->|"sends requests"| node_auth_api
node_app_entry -->|"registers router"| node_auth_api
node_app_entry -->|"registers router"| node_exam_api
node_app_entry -->|"creates tables"| node_db
node_auth_api -->|"queries users"| node_db
node_auth_api -->|"queries users"| node_user_model
node_exam_api -->|"queries records"| node_db
node_exam_api -->|"checks role"| node_user_model
node_exam_api -->|"queries exams"| node_exam_model
node_exam_api -->|"queries questions"| node_question_model
node_exam_api -->|"validates payloads"| node_exam_form_schema
node_auth_api -->|"authenticates with"| node_google
node_browser -.->|"triggers exam controls"| node_monitoring
node_monitoring -.->|"reports violations"| node_exam_api
node_coding -.->|"runs submissions"| node_judge0
node_qie -.->|"generates questions"| node_ai_provider
node_admin_dashboard -.->|"views reports"| node_educator_reports

click node_admin_ui "https://github.com/chiragkewlani01/safeexam-platform/blob/main/client/app/admin/create-exam/CreateExamForm.tsx"
click node_admin_dashboard "https://github.com/chiragkewlani01/safeexam-platform/blob/main/client/app/dashboard/DashboardAdmin.tsx"
click node_student_dashboard "https://github.com/chiragkewlani01/safeexam-platform/blob/main/client/app/dashboard/DashboardStudent.tsx"
click node_join_form "https://github.com/chiragkewlani01/safeexam-platform/blob/main/client/app/student/join-exam/JoinExamForm.tsx"
click node_navbar "https://github.com/chiragkewlani01/safeexam-platform/blob/main/client/components/Navbar.tsx"
click node_auth_state "https://github.com/chiragkewlani01/safeexam-platform/blob/main/client/store/useAuthStore.ts"
click node_api_client "https://github.com/chiragkewlani01/safeexam-platform/blob/main/client/lib/api.ts"
click node_auth_api "https://github.com/chiragkewlani01/safeexam-platform/blob/main/server/app/api/auth.py"
click node_user_model "https://github.com/chiragkewlani01/safeexam-platform/blob/main/server/app/models/user.py"
click node_exam_api "https://github.com/chiragkewlani01/safeexam-platform/blob/main/server/app/api/exams.py"
click node_exam_form_schema "https://github.com/chiragkewlani01/safeexam-platform/blob/main/server/app/schemas/exam.py"
click node_exam_model "https://github.com/chiragkewlani01/safeexam-platform/blob/main/server/app/models/exam.py"
click node_question_model "https://github.com/chiragkewlani01/safeexam-platform/blob/main/server/app/models/question.py"
click node_db "https://github.com/chiragkewlani01/safeexam-platform/blob/main/server/app/core/database.py"
click node_app_entry "https://github.com/chiragkewlani01/safeexam-platform/blob/main/server/app/main.py"
click node_monitoring "https://github.com/chiragkewlani01/safeexam-platform/tree/main/server/app/api"
click node_coding "https://github.com/chiragkewlani01/safeexam-platform/tree/main/server/app/api"
click node_qie "https://github.com/chiragkewlani01/safeexam-platform/tree/main/server/app/api"
click node_educator_reports "https://github.com/chiragkewlani01/safeexam-platform/tree/main/server/app/api"

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_admin_ui,node_admin_dashboard,node_student_dashboard,node_join_form,node_navbar,node_auth_state,node_api_client,node_browser toneBlue
class node_auth_api,node_user_model toneAmber
class node_exam_api,node_exam_form_schema,node_exam_model,node_question_model,node_ai_provider toneMint
class node_db,node_app_entry toneRose
class node_monitoring,node_coding,node_qie,node_educator_reports,node_google,node_judge0 toneIndigo
```

## Components

### Web client

- [Educator exam form](https://github.com/chiragkewlani01/safeexam-platform/blob/main/client/app/admin/create-exam/CreateExamForm.tsx): `client/app/admin/create-exam/CreateExamForm.tsx`
- [Educator dashboard](https://github.com/chiragkewlani01/safeexam-platform/blob/main/client/app/dashboard/DashboardAdmin.tsx): `client/app/dashboard/DashboardAdmin.tsx`
- [Student dashboard](https://github.com/chiragkewlani01/safeexam-platform/blob/main/client/app/dashboard/DashboardStudent.tsx): `client/app/dashboard/DashboardStudent.tsx`
- [Join exam form](https://github.com/chiragkewlani01/safeexam-platform/blob/main/client/app/student/join-exam/JoinExamForm.tsx): `client/app/student/join-exam/JoinExamForm.tsx`
- [Navigation](https://github.com/chiragkewlani01/safeexam-platform/blob/main/client/components/Navbar.tsx): `client/components/Navbar.tsx`
- [Auth state](https://github.com/chiragkewlani01/safeexam-platform/blob/main/client/store/useAuthStore.ts): `client/store/useAuthStore.ts`
- [API client](https://github.com/chiragkewlani01/safeexam-platform/blob/main/client/lib/api.ts): `client/lib/api.ts`

### Identity

- [Auth endpoints](https://github.com/chiragkewlani01/safeexam-platform/blob/main/server/app/api/auth.py): `server/app/api/auth.py`
- [User records](https://github.com/chiragkewlani01/safeexam-platform/blob/main/server/app/models/user.py): `server/app/models/user.py`

### Exam workflow

- [Exam endpoints](https://github.com/chiragkewlani01/safeexam-platform/blob/main/server/app/api/exams.py): `server/app/api/exams.py`
- [Exam schemas](https://github.com/chiragkewlani01/safeexam-platform/blob/main/server/app/schemas/exam.py): `server/app/schemas/exam.py`
- [Exam records](https://github.com/chiragkewlani01/safeexam-platform/blob/main/server/app/models/exam.py): `server/app/models/exam.py`
- [Question records](https://github.com/chiragkewlani01/safeexam-platform/blob/main/server/app/models/question.py): `server/app/models/question.py`

### API and persistence

- [Database access](https://github.com/chiragkewlani01/safeexam-platform/blob/main/server/app/core/database.py): `server/app/core/database.py`
- [FastAPI app](https://github.com/chiragkewlani01/safeexam-platform/blob/main/server/app/main.py): `server/app/main.py`

### Documented capabilities

- [Integrity monitoring](https://github.com/chiragkewlani01/safeexam-platform/tree/main/server/app/api): `server/app/api`
- [Coding exams](https://github.com/chiragkewlani01/safeexam-platform/tree/main/server/app/api): `server/app/api`
- [AI question generation](https://github.com/chiragkewlani01/safeexam-platform/tree/main/server/app/api): `server/app/api`
- [Reports and analytics](https://github.com/chiragkewlani01/safeexam-platform/tree/main/server/app/api): `server/app/api`

### Other components

- **Browser user**
- **Google OAuth**
- **Judge0 execution**
- **Gemini / OpenRouter**

## Connections

- Browser user → Educator exam form: creates exam
- Browser user → Join exam form: joins exam
- Educator exam form → Exam endpoints: creates exam
- Join exam form → Exam endpoints: joins by code
- Student dashboard → Exam endpoints: views exams
- Educator dashboard → Exam endpoints: manages exams
- Navigation → Auth state: reads session (evidence: `client/components/Navbar.tsx`)
- Navigation → Auth endpoints: logs out
- API client → Exam endpoints: sends requests
- API client → Auth endpoints: sends requests
- FastAPI app → Auth endpoints: registers router (evidence: `server/app/main.py`)
- FastAPI app → Exam endpoints: registers router (evidence: `server/app/main.py`)
- FastAPI app → Database access: creates tables (evidence: `server/app/main.py`)
- Auth endpoints → Database access: queries users (evidence: `server/app/api/auth.py`)
- Auth endpoints → User records: queries users (evidence: `server/app/api/auth.py`)
- Exam endpoints → Database access: queries records (evidence: `server/app/api/exams.py`)
- Exam endpoints → User records: checks role (evidence: `server/app/api/exams.py`)
- Exam endpoints → Exam records: queries exams (evidence: `server/app/api/exams.py`)
- Exam endpoints → Question records: queries questions (evidence: `server/app/api/exams.py`)
- Exam endpoints → Exam schemas: validates payloads (evidence: `server/app/api/exams.py`)
- Auth endpoints → Google OAuth: authenticates with (evidence: `server/app/api/auth.py`)
- Browser user → Integrity monitoring: triggers exam controls
- Integrity monitoring → Exam endpoints: reports violations (evidence: `server/app/api/exams.py`)
- Coding exams → Judge0 execution: runs submissions
- AI question generation → Gemini / OpenRouter: generates questions
- Educator dashboard → Reports and analytics: views reports
