# tharunbalajis/edu-saas-platform architecture

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

- Interactive diagram: https://gitdiagram.com/tharunbalajis/edu-saas-platform
- Repository: https://github.com/tharunbalajis/edu-saas-platform

## Overview

EduOS is a role-based education platform for college administration, faculty, and students. Users sign in, then use role-specific screens to manage classrooms and academic activity, maintain student profiles and resumes, view results and placement information, and access administrative analytics. The frontend uses a shared authenticated API client to reach a modular backend. The excerpts establish several frontend routes, auth flows, and storage calls; many feature modules are represented from the tree and source index, so uncertain service-to-service links are omitted.

Main entry points: [`frontend/src/modules/student/pages/StudentDashboardPage.tsx`](https://github.com/tharunbalajis/edu-saas-platform/blob/main/frontend/src/modules/student/pages/StudentDashboardPage.tsx) (Student workspace), [`frontend/src/modules/faculty/pages/ClassroomDetailPage.tsx`](https://github.com/tharunbalajis/edu-saas-platform/blob/main/frontend/src/modules/faculty/pages/ClassroomDetailPage.tsx) (Faculty workspace), [`frontend/src/modules/super-admin/pages/AnalyticsPage.tsx`](https://github.com/tharunbalajis/edu-saas-platform/blob/main/frontend/src/modules/super-admin/pages/AnalyticsPage.tsx) (Admin workspace), [`frontend/src/routes/AppRoutes.tsx`](https://github.com/tharunbalajis/edu-saas-platform/blob/main/frontend/src/routes/AppRoutes.tsx) (Role routes)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_frontend["Web application"]
  node_web["Role-based app<br/>[App.tsx]"]
  node_routes["Role routes<br/>[AppRoutes.tsx]"]
  node_faculty["Faculty workspace"]
  node_student["Student workspace"]
  node_admin["Admin workspace<br/>[AnalyticsPage.tsx]"]
  node_api["Shared API client<br/>[apiClient.ts]"]
end

subgraph group_identity["Identity and access"]
  node_authui["Login and session<br/>[AuthContext.tsx]"]
  node_auth["Authentication service<br/>[auth.service.ts]"]
  node_rbac["Role permissions<br/>[rbac.service.ts]"]
end

subgraph group_learning["Learning and student services"]
  node_classroom["Classroom service"]
  node_academics["Academic records"]
  node_submissions["Assignments"]
  node_profiles["Student profiles"]
  node_resume["Resume service<br/>[resume.service.ts]"]
  node_results["Results service<br/>[results.service.ts]"]
  node_placement["Placement service"]
  node_chatbot["AI chatbot<br/>[chatbot.service.ts]"]
end

subgraph group_administration["College administration"]
  node_analytics["Analytics"]
  node_colleges["College management"]
  node_users["User management<br/>[users.service.ts]"]
  node_notifications["Notifications"]
end

subgraph group_platform["Backend platform"]
  node_storage["File storage service<br/>[storage.service.ts]"]
  node_supabase["Supabase Storage"]
  node_postgres[("PostgreSQL data")]
  node_redis[("Redis")]
  node_nvidia["NVIDIA AI service"]
end

node_user(("Platform user"))

node_user -->|"uses"| node_web
node_web -->|"renders"| node_routes
node_routes -->|"routes login"| node_authui
node_routes -->|"routes faculty"| node_faculty
node_routes -->|"routes student"| node_student
node_routes -->|"routes admin"| node_admin
node_authui -->|"calls"| node_api
node_faculty -.->|"calls"| node_api
node_student -.->|"calls"| node_api
node_admin -.->|"calls"| node_api
node_api -.->|"HTTP auth requests"| node_auth
node_auth -->|"gets permissions"| node_rbac
node_auth -->|"checks token state"| node_redis
node_faculty -.->|"uses classroom features"| node_classroom
node_student -.->|"uses classroom features"| node_classroom
node_faculty -.->|"uses academic features"| node_academics
node_faculty -.->|"reviews submissions"| node_submissions
node_student -.->|"submits work"| node_submissions
node_student -.->|"edits profile"| node_profiles
node_student -.->|"uses resume tools"| node_resume
node_student -.->|"views results"| node_results
node_student -.->|"views placement"| node_placement
node_web -.->|"offers chatbot"| node_chatbot
node_admin -.->|"views analytics"| node_analytics
node_admin -.->|"manages colleges"| node_colleges
node_admin -.->|"manages users"| node_users
node_admin -.->|"broadcasts notices"| node_notifications
node_faculty -->|"uploads classroom files"| node_storage
node_student -->|"uploads submission files"| node_storage
node_storage -.->|"stores files"| node_supabase
node_storage -.->|"records file metadata"| node_postgres
node_chatbot -.->|"uses AI provider"| node_nvidia

click node_web "https://github.com/tharunbalajis/edu-saas-platform/blob/main/frontend/src/App.tsx"
click node_routes "https://github.com/tharunbalajis/edu-saas-platform/blob/main/frontend/src/routes/AppRoutes.tsx"
click node_faculty "https://github.com/tharunbalajis/edu-saas-platform/blob/main/frontend/src/modules/faculty/pages/ClassroomDetailPage.tsx"
click node_student "https://github.com/tharunbalajis/edu-saas-platform/blob/main/frontend/src/modules/student/pages/StudentDashboardPage.tsx"
click node_admin "https://github.com/tharunbalajis/edu-saas-platform/blob/main/frontend/src/modules/super-admin/pages/AnalyticsPage.tsx"
click node_api "https://github.com/tharunbalajis/edu-saas-platform/blob/main/frontend/src/shared/lib/apiClient.ts"
click node_authui "https://github.com/tharunbalajis/edu-saas-platform/blob/main/frontend/src/shared/context/AuthContext.tsx"
click node_auth "https://github.com/tharunbalajis/edu-saas-platform/blob/main/backend/src/modules/auth/auth.service.ts"
click node_rbac "https://github.com/tharunbalajis/edu-saas-platform/blob/main/backend/src/modules/rbac/rbac.service.ts"
click node_classroom "https://github.com/tharunbalajis/edu-saas-platform/blob/main/backend/src/modules/classroom/classroom.service.ts"
click node_academics "https://github.com/tharunbalajis/edu-saas-platform/blob/main/backend/src/modules/academics/academics.service.ts"
click node_submissions "https://github.com/tharunbalajis/edu-saas-platform/blob/main/backend/src/modules/submissions/submissions.service.ts"
click node_profiles "https://github.com/tharunbalajis/edu-saas-platform/blob/main/backend/src/modules/profiles/profiles.service.ts"
click node_resume "https://github.com/tharunbalajis/edu-saas-platform/blob/main/backend/src/modules/resume/resume.service.ts"
click node_results "https://github.com/tharunbalajis/edu-saas-platform/blob/main/backend/src/modules/results/results.service.ts"
click node_placement "https://github.com/tharunbalajis/edu-saas-platform/blob/main/backend/src/modules/placement/placement.service.ts"
click node_chatbot "https://github.com/tharunbalajis/edu-saas-platform/blob/main/backend/src/modules/chatbot/chatbot.service.ts"
click node_analytics "https://github.com/tharunbalajis/edu-saas-platform/blob/main/backend/src/modules/analytics/analytics.service.ts"
click node_colleges "https://github.com/tharunbalajis/edu-saas-platform/blob/main/backend/src/modules/colleges/colleges.service.ts"
click node_users "https://github.com/tharunbalajis/edu-saas-platform/blob/main/backend/src/modules/users/users.service.ts"
click node_notifications "https://github.com/tharunbalajis/edu-saas-platform/blob/main/backend/src/modules/notifications/notifications.service.ts"
click node_storage "https://github.com/tharunbalajis/edu-saas-platform/blob/main/backend/src/modules/storage/storage.service.ts"

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_web,node_routes,node_faculty,node_student,node_admin,node_api,node_user toneBlue
class node_authui,node_auth,node_rbac toneAmber
class node_classroom,node_academics,node_submissions,node_profiles,node_resume,node_results,node_placement,node_chatbot toneMint
class node_analytics,node_colleges,node_users,node_notifications toneRose
class node_storage,node_supabase,node_postgres,node_redis,node_nvidia toneIndigo
```

## Components

### Web application

- [Role-based app](https://github.com/tharunbalajis/edu-saas-platform/blob/main/frontend/src/App.tsx): `frontend/src/App.tsx`
- [Role routes](https://github.com/tharunbalajis/edu-saas-platform/blob/main/frontend/src/routes/AppRoutes.tsx): `frontend/src/routes/AppRoutes.tsx`
- [Faculty workspace](https://github.com/tharunbalajis/edu-saas-platform/blob/main/frontend/src/modules/faculty/pages/ClassroomDetailPage.tsx): `frontend/src/modules/faculty/pages/ClassroomDetailPage.tsx`
- [Student workspace](https://github.com/tharunbalajis/edu-saas-platform/blob/main/frontend/src/modules/student/pages/StudentDashboardPage.tsx): `frontend/src/modules/student/pages/StudentDashboardPage.tsx`
- [Admin workspace](https://github.com/tharunbalajis/edu-saas-platform/blob/main/frontend/src/modules/super-admin/pages/AnalyticsPage.tsx): `frontend/src/modules/super-admin/pages/AnalyticsPage.tsx`
- [Shared API client](https://github.com/tharunbalajis/edu-saas-platform/blob/main/frontend/src/shared/lib/apiClient.ts): `frontend/src/shared/lib/apiClient.ts`

### Identity and access

- [Login and session](https://github.com/tharunbalajis/edu-saas-platform/blob/main/frontend/src/shared/context/AuthContext.tsx): `frontend/src/shared/context/AuthContext.tsx`
- [Authentication service](https://github.com/tharunbalajis/edu-saas-platform/blob/main/backend/src/modules/auth/auth.service.ts): `backend/src/modules/auth/auth.service.ts`
- [Role permissions](https://github.com/tharunbalajis/edu-saas-platform/blob/main/backend/src/modules/rbac/rbac.service.ts): `backend/src/modules/rbac/rbac.service.ts`

### Learning and student services

- [Classroom service](https://github.com/tharunbalajis/edu-saas-platform/blob/main/backend/src/modules/classroom/classroom.service.ts): `backend/src/modules/classroom/classroom.service.ts`
- [Academic records](https://github.com/tharunbalajis/edu-saas-platform/blob/main/backend/src/modules/academics/academics.service.ts): `backend/src/modules/academics/academics.service.ts`
- [Assignments](https://github.com/tharunbalajis/edu-saas-platform/blob/main/backend/src/modules/submissions/submissions.service.ts): `backend/src/modules/submissions/submissions.service.ts`
- [Student profiles](https://github.com/tharunbalajis/edu-saas-platform/blob/main/backend/src/modules/profiles/profiles.service.ts): `backend/src/modules/profiles/profiles.service.ts`
- [Resume service](https://github.com/tharunbalajis/edu-saas-platform/blob/main/backend/src/modules/resume/resume.service.ts): `backend/src/modules/resume/resume.service.ts`
- [Results service](https://github.com/tharunbalajis/edu-saas-platform/blob/main/backend/src/modules/results/results.service.ts): `backend/src/modules/results/results.service.ts`
- [Placement service](https://github.com/tharunbalajis/edu-saas-platform/blob/main/backend/src/modules/placement/placement.service.ts): `backend/src/modules/placement/placement.service.ts`
- [AI chatbot](https://github.com/tharunbalajis/edu-saas-platform/blob/main/backend/src/modules/chatbot/chatbot.service.ts): `backend/src/modules/chatbot/chatbot.service.ts`

### College administration

- [Analytics](https://github.com/tharunbalajis/edu-saas-platform/blob/main/backend/src/modules/analytics/analytics.service.ts): `backend/src/modules/analytics/analytics.service.ts`
- [College management](https://github.com/tharunbalajis/edu-saas-platform/blob/main/backend/src/modules/colleges/colleges.service.ts): `backend/src/modules/colleges/colleges.service.ts`
- [User management](https://github.com/tharunbalajis/edu-saas-platform/blob/main/backend/src/modules/users/users.service.ts): `backend/src/modules/users/users.service.ts`
- [Notifications](https://github.com/tharunbalajis/edu-saas-platform/blob/main/backend/src/modules/notifications/notifications.service.ts): `backend/src/modules/notifications/notifications.service.ts`

### Backend platform

- [File storage service](https://github.com/tharunbalajis/edu-saas-platform/blob/main/backend/src/modules/storage/storage.service.ts): `backend/src/modules/storage/storage.service.ts`
- **Supabase Storage**
- **PostgreSQL data**
- **Redis**
- **NVIDIA AI service**

### Other components

- **Platform user**

## Connections

- Platform user → Role-based app: uses
- Role-based app → Role routes: renders (evidence: `frontend/src/App.tsx`)
- Role routes → Login and session: routes login (evidence: `frontend/src/routes/AppRoutes.tsx`)
- Role routes → Faculty workspace: routes faculty (evidence: `frontend/src/routes/AppRoutes.tsx`)
- Role routes → Student workspace: routes student (evidence: `frontend/src/routes/AppRoutes.tsx`)
- Role routes → Admin workspace: routes admin (evidence: `frontend/src/routes/AppRoutes.tsx`)
- Login and session → Shared API client: calls (evidence: `frontend/src/shared/context/AuthContext.tsx`)
- Faculty workspace → Shared API client: calls
- Student workspace → Shared API client: calls
- Admin workspace → Shared API client: calls
- Shared API client → Authentication service: HTTP auth requests
- Authentication service → Role permissions: gets permissions (evidence: `backend/src/modules/auth/auth.service.ts`)
- Authentication service → Redis: checks token state (evidence: `backend/src/modules/auth/auth.service.ts`)
- Faculty workspace → Classroom service: uses classroom features
- Student workspace → Classroom service: uses classroom features
- Faculty workspace → Academic records: uses academic features
- Faculty workspace → Assignments: reviews submissions
- Student workspace → Assignments: submits work
- Student workspace → Student profiles: edits profile
- Student workspace → Resume service: uses resume tools
- Student workspace → Results service: views results
- Student workspace → Placement service: views placement
- Role-based app → AI chatbot: offers chatbot
- Admin workspace → Analytics: views analytics
- Admin workspace → College management: manages colleges
- Admin workspace → User management: manages users
- Admin workspace → Notifications: broadcasts notices
- Faculty workspace → File storage service: uploads classroom files
- Student workspace → File storage service: uploads submission files
- File storage service → Supabase Storage: stores files
- File storage service → PostgreSQL data: records file metadata
- AI chatbot → NVIDIA AI service: uses AI provider
