# revaldo007/neet-portal architecture

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

## Overview

NEET Examination Portal supports student registration, application submission and administration, then an approved student’s admit card and timed mock exam with results. The React app calls a FastAPI backend; backend routes implement the domain workflows over relational models. The README documents simulated payments and disk-based document uploads. Some frontend screens and backend routers were not excerpted, so their feature coverage and connections rely on README statements and SOURCE INDEX references rather than inspected implementation details.

Main entry points: [`backend/app/main.py`](https://github.com/revaldo007/neet-portal/blob/main/backend/app/main.py) (API Startup), [`backend/app/database.py`](https://github.com/revaldo007/neet-portal/blob/main/backend/app/database.py) (SQL Database), [`frontend/src/App.jsx`](https://github.com/revaldo007/neet-portal/blob/main/frontend/src/App.jsx) (Portal Navigation), [`backend/app/routers/application.py`](https://github.com/revaldo007/neet-portal/blob/main/backend/app/routers/application.py) (Application Routes)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_web["Student and Admin UI"]
  node_app["Portal Navigation<br/>[App.jsx]"]
  node_authui["Auth Context<br/>[AuthContext.jsx]"]
  node_studentpages["Student Pages"]
  node_adminpages["Admin Pages"]
  node_client["HTTP Client<br/>[client.js]"]
end

subgraph group_api["API and Identity"]
  node_authroutes["Auth Routes<br/>[auth.py]"]
  node_application["Application Routes<br/>[application.py]"]
  node_adminroutes["Admin Routes<br/>[admin.py]"]
  node_entry["API Startup<br/>[main.py]"]
  node_security["JWT Security<br/>[auth.py]"]
end

subgraph group_exam["Exam Workflows"]
  node_examroutes["Exam Routes<br/>[exam.py]"]
  node_schedule["Exam Cycle Setup"]
  node_questions["Question Bank<br/>[AdminQuestions.jsx]"]
  node_results["Exam Results<br/>[MockExam.jsx]"]
end

subgraph group_state["Persistence and Files"]
  node_models["Domain Models<br/>[models.py]"]
  node_database[("SQL Database<br/>[database.py]")]
  node_uploads["Document Files<br/>[application.py]"]
end

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

node_student -->|"uses"| node_app
node_administrator -->|"uses"| node_app
node_app -->|"provides auth"| node_authui
node_app -->|"routes student"| node_studentpages
node_app -->|"routes admin"| node_adminpages
node_authui -->|"sends auth requests"| node_client
node_studentpages -->|"calls API"| node_client
node_adminpages -->|"calls API"| node_client
node_client -->|"requests backend"| node_entry
node_entry -->|"registers"| node_authroutes
node_entry -->|"registers"| node_application
node_entry -->|"registers"| node_examroutes
node_entry -->|"registers"| node_adminroutes
node_authroutes -->|"uses"| node_security
node_authroutes -->|"queries"| node_database
node_application -->|"checks student"| node_security
node_application -->|"reads and writes"| node_database
node_application -->|"stores documents"| node_uploads
node_adminroutes -->|"reads and writes"| node_database
node_adminroutes -->|"checks admin"| node_security
node_examroutes -->|"reads and writes"| node_database
node_examroutes -->|"checks student"| node_security
node_models -->|"uses base"| node_database
node_entry -->|"creates tables"| node_database
node_schedule -->|"configures"| node_adminpages
node_questions -->|"manages"| node_adminpages
node_studentpages -->|"includes exam"| node_results
node_results -.->|"submits exam"| node_examroutes

click node_app "https://github.com/revaldo007/neet-portal/blob/main/frontend/src/App.jsx"
click node_authui "https://github.com/revaldo007/neet-portal/blob/main/frontend/src/context/AuthContext.jsx"
click node_studentpages "https://github.com/revaldo007/neet-portal/tree/main/frontend/src/pages"
click node_adminpages "https://github.com/revaldo007/neet-portal/tree/main/frontend/src/pages/admin"
click node_client "https://github.com/revaldo007/neet-portal/blob/main/frontend/src/api/client.js"
click node_authroutes "https://github.com/revaldo007/neet-portal/blob/main/backend/app/routers/auth.py"
click node_application "https://github.com/revaldo007/neet-portal/blob/main/backend/app/routers/application.py"
click node_adminroutes "https://github.com/revaldo007/neet-portal/blob/main/backend/app/routers/admin.py"
click node_examroutes "https://github.com/revaldo007/neet-portal/blob/main/backend/app/routers/exam.py"
click node_entry "https://github.com/revaldo007/neet-portal/blob/main/backend/app/main.py"
click node_security "https://github.com/revaldo007/neet-portal/blob/main/backend/app/auth.py"
click node_models "https://github.com/revaldo007/neet-portal/blob/main/backend/app/models.py"
click node_database "https://github.com/revaldo007/neet-portal/blob/main/backend/app/database.py"
click node_uploads "https://github.com/revaldo007/neet-portal/blob/main/backend/app/routers/application.py"
click node_schedule "https://github.com/revaldo007/neet-portal/blob/main/frontend/src/pages/admin/AdminExamSchedule.jsx"
click node_questions "https://github.com/revaldo007/neet-portal/blob/main/frontend/src/pages/admin/AdminQuestions.jsx"
click node_results "https://github.com/revaldo007/neet-portal/blob/main/frontend/src/pages/MockExam.jsx"

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_authui,node_studentpages,node_adminpages,node_client toneBlue
class node_authroutes,node_application,node_adminroutes,node_entry,node_security toneAmber
class node_examroutes,node_schedule,node_questions,node_results toneMint
class node_models,node_database,node_uploads toneRose
class node_student,node_administrator toneIndigo
```

## Components

### Student and Admin UI

- [Portal Navigation](https://github.com/revaldo007/neet-portal/blob/main/frontend/src/App.jsx): `frontend/src/App.jsx`
- [Auth Context](https://github.com/revaldo007/neet-portal/blob/main/frontend/src/context/AuthContext.jsx): `frontend/src/context/AuthContext.jsx`
- [Student Pages](https://github.com/revaldo007/neet-portal/tree/main/frontend/src/pages): `frontend/src/pages`
- [Admin Pages](https://github.com/revaldo007/neet-portal/tree/main/frontend/src/pages/admin): `frontend/src/pages/admin`
- [HTTP Client](https://github.com/revaldo007/neet-portal/blob/main/frontend/src/api/client.js): `frontend/src/api/client.js`

### API and Identity

- [Auth Routes](https://github.com/revaldo007/neet-portal/blob/main/backend/app/routers/auth.py): `backend/app/routers/auth.py`
- [Application Routes](https://github.com/revaldo007/neet-portal/blob/main/backend/app/routers/application.py): `backend/app/routers/application.py`
- [Admin Routes](https://github.com/revaldo007/neet-portal/blob/main/backend/app/routers/admin.py): `backend/app/routers/admin.py`
- [API Startup](https://github.com/revaldo007/neet-portal/blob/main/backend/app/main.py): `backend/app/main.py`
- [JWT Security](https://github.com/revaldo007/neet-portal/blob/main/backend/app/auth.py): `backend/app/auth.py`

### Exam Workflows

- [Exam Routes](https://github.com/revaldo007/neet-portal/blob/main/backend/app/routers/exam.py): `backend/app/routers/exam.py`
- [Exam Cycle Setup](https://github.com/revaldo007/neet-portal/blob/main/frontend/src/pages/admin/AdminExamSchedule.jsx): `frontend/src/pages/admin/AdminExamSchedule.jsx`
- [Question Bank](https://github.com/revaldo007/neet-portal/blob/main/frontend/src/pages/admin/AdminQuestions.jsx): `frontend/src/pages/admin/AdminQuestions.jsx`
- [Exam Results](https://github.com/revaldo007/neet-portal/blob/main/frontend/src/pages/MockExam.jsx): `frontend/src/pages/MockExam.jsx`

### Persistence and Files

- [Domain Models](https://github.com/revaldo007/neet-portal/blob/main/backend/app/models.py): `backend/app/models.py`
- [SQL Database](https://github.com/revaldo007/neet-portal/blob/main/backend/app/database.py): `backend/app/database.py`
- [Document Files](https://github.com/revaldo007/neet-portal/blob/main/backend/app/routers/application.py): `backend/app/routers/application.py`

### Other components

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

## Connections

- Student → Portal Navigation: uses (evidence: `frontend/src/App.jsx`)
- Administrator → Portal Navigation: uses (evidence: `frontend/src/App.jsx`)
- Portal Navigation → Auth Context: provides auth (evidence: `frontend/src/App.jsx`)
- Portal Navigation → Student Pages: routes student (evidence: `frontend/src/App.jsx`)
- Portal Navigation → Admin Pages: routes admin (evidence: `frontend/src/App.jsx`)
- Auth Context → HTTP Client: sends auth requests (evidence: `frontend/src/context/AuthContext.jsx`)
- Student Pages → HTTP Client: calls API (evidence: `frontend/src/pages/ApplicationForm.jsx`)
- Admin Pages → HTTP Client: calls API (evidence: `frontend/src/pages/admin/AdminExamSchedule.jsx`)
- HTTP Client → API Startup: requests backend (evidence: `README.md`)
- API Startup → Auth Routes: registers (evidence: `backend/app/main.py`)
- API Startup → Application Routes: registers (evidence: `backend/app/main.py`)
- API Startup → Exam Routes: registers (evidence: `backend/app/main.py`)
- API Startup → Admin Routes: registers (evidence: `backend/app/main.py`)
- Auth Routes → JWT Security: uses (evidence: `backend/app/routers/auth.py`)
- Auth Routes → SQL Database: queries (evidence: `backend/app/routers/auth.py`)
- Application Routes → JWT Security: checks student (evidence: `backend/app/routers/application.py`)
- Application Routes → SQL Database: reads and writes (evidence: `backend/app/routers/application.py`)
- Application Routes → Document Files: stores documents (evidence: `backend/app/routers/application.py`)
- Admin Routes → SQL Database: reads and writes (evidence: `backend/app/routers/admin.py`)
- Admin Routes → JWT Security: checks admin (evidence: `backend/app/routers/admin.py`)
- Exam Routes → SQL Database: reads and writes (evidence: `backend/app/routers/exam.py`)
- Exam Routes → JWT Security: checks student (evidence: `backend/app/routers/exam.py`)
- Domain Models → SQL Database: uses base (evidence: `backend/app/models.py`)
- API Startup → SQL Database: creates tables (evidence: `backend/app/main.py`)
- Exam Cycle Setup → Admin Pages: configures (evidence: `frontend/src/App.jsx`)
- Question Bank → Admin Pages: manages (evidence: `frontend/src/App.jsx`)
- Student Pages → Exam Results: includes exam (evidence: `frontend/src/App.jsx`)
- Exam Results → Exam Routes: submits exam
