# vagabond2003/smart-campus architecture

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

## Overview

Smart Campus is a student-facing academic portal: users sign in or activate an account, then view academic and account information and perform student actions such as RIB registration, simulated bill payment, course discussion, and notification reading. Documented capabilities include schedules, attendance, results, admit cards, profile, and dashboard; many page implementations are listed in the tree but not sampled, so their internal interactions are not inferred. Edges below are limited to relationships explicit in the README or sampled source index/excerpts.

Main entry points: [`src/app/router.tsx`](https://github.com/vagabond2003/smart-campus/blob/main/src/app/router.tsx) (Route access), [`src/api/hooks.ts`](https://github.com/vagabond2003/smart-campus/blob/main/src/api/hooks.ts) (Query and mutation hooks), [`src/app/auth.tsx`](https://github.com/vagabond2003/smart-campus/blob/main/src/app/auth.tsx) (Sign-in and activation), [`src/data/seed.ts`](https://github.com/vagabond2003/smart-campus/blob/main/src/data/seed.ts) (Synthetic academic data)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Access and navigation"]
  node_router["Route access<br/>[router.tsx]"]
  node_auth["Sign-in and activation<br/>[auth.tsx]"]
  node_shell["Portal shell<br/>[AppShell.tsx]"]
end

subgraph group_academic["Academic services"]
  node_dashboard["Dashboard<br/>[Dashboard.tsx]"]
  node_course["Courses and discussion<br/>[CourseTab.tsx]"]
  node_attendance["Attendance"]
  node_results["Results and CGPA<br/>[Results.tsx]"]
  node_routine["Class routine<br/>[ClassRoutine.tsx]"]
  node_exam["Exam schedule<br/>[ExamRoutine.tsx]"]
  node_admit["Admit card<br/>[AdmitCard.tsx]"]
end

subgraph group_account["Student actions"]
  node_registration["Course registration"]
  node_rib["RIB registration"]
  node_bills["Bills and payments<br/>[Bills.tsx]"]
  node_profile["Student profile<br/>[Profile.tsx]"]
  node_receipt["Payment receipt<br/>[Receipt.tsx]"]
  node_notices["Notifications<br/>[ShellMenus.tsx]"]
end

subgraph group_data["Data and persistence"]
  node_seed["Synthetic academic data<br/>[seed.ts]"]
  node_store[("Student in-memory store<br/>[store.ts]")]
  node_selectors["Academic selectors<br/>[derive.ts]"]
  node_queries["Query and mutation hooks<br/>[hooks.ts]"]
  node_cloud["Cloud persistence<br/>[cloud.ts]"]
  node_firebase["Firebase services<br/>[firebase.ts]"]
  node_clock["Academic clock<br/>[clock.ts]"]
end

node_student(("Student"))

node_student -->|"opens pages"| node_router
node_router -->|"guards routes"| node_auth
node_router -->|"renders"| node_shell
node_router -->|"routes to"| node_dashboard
node_router -->|"routes to"| node_course
node_router -->|"routes to"| node_attendance
node_router -->|"routes to"| node_results
node_router -->|"routes to"| node_routine
node_router -->|"routes to"| node_exam
node_router -->|"routes to"| node_admit
node_router -->|"routes to"| node_registration
node_router -->|"routes to"| node_rib
node_router -->|"routes to"| node_bills
node_router -->|"routes to"| node_profile
node_router -->|"routes to"| node_receipt
node_auth -->|"loads profile"| node_cloud
node_auth -->|"creates profile"| node_cloud
node_auth -->|"authenticates"| node_firebase
node_queries -->|"reads shared data"| node_seed
node_queries -->|"reads and mutates"| node_store
node_queries -->|"computes views"| node_selectors
node_queries -->|"persists mutations"| node_cloud
node_cloud -->|"uses services"| node_firebase
node_store -->|"initializes from"| node_seed
node_selectors -->|"derives from"| node_seed
node_seed -->|"anchors dates"| node_clock
node_selectors -->|"uses calendar"| node_clock
node_dashboard -->|"loads data"| node_queries
node_course -->|"loads data"| node_queries
node_bills -->|"loads and mutates"| node_queries
node_results -->|"loads data"| node_queries
node_shell -.->|"includes menus"| node_notices
node_rib -.->|"registers"| node_queries
node_registration -.->|"loads options"| node_queries
node_attendance -.->|"loads data"| node_queries
node_routine -.->|"loads data"| node_queries
node_exam -.->|"loads data"| node_queries
node_admit -.->|"loads data"| node_queries
node_profile -.->|"loads data"| node_queries
node_receipt -.->|"shows payment"| node_bills

click node_router "https://github.com/vagabond2003/smart-campus/blob/main/src/app/router.tsx"
click node_auth "https://github.com/vagabond2003/smart-campus/blob/main/src/app/auth.tsx"
click node_shell "https://github.com/vagabond2003/smart-campus/blob/main/src/shell/AppShell.tsx"
click node_dashboard "https://github.com/vagabond2003/smart-campus/blob/main/src/pages/Dashboard.tsx"
click node_course "https://github.com/vagabond2003/smart-campus/blob/main/src/pages/course/CourseTab.tsx"
click node_attendance "https://github.com/vagabond2003/smart-campus/blob/main/src/pages/AttendanceSummary.tsx"
click node_results "https://github.com/vagabond2003/smart-campus/blob/main/src/pages/Results.tsx"
click node_routine "https://github.com/vagabond2003/smart-campus/blob/main/src/pages/ClassRoutine.tsx"
click node_exam "https://github.com/vagabond2003/smart-campus/blob/main/src/pages/ExamRoutine.tsx"
click node_admit "https://github.com/vagabond2003/smart-campus/blob/main/src/pages/AdmitCard.tsx"
click node_registration "https://github.com/vagabond2003/smart-campus/blob/main/src/pages/RegularRegistration.tsx"
click node_rib "https://github.com/vagabond2003/smart-campus/blob/main/src/pages/RibRegistration.tsx"
click node_bills "https://github.com/vagabond2003/smart-campus/blob/main/src/pages/Bills.tsx"
click node_profile "https://github.com/vagabond2003/smart-campus/blob/main/src/pages/Profile.tsx"
click node_receipt "https://github.com/vagabond2003/smart-campus/blob/main/src/pages/Receipt.tsx"
click node_notices "https://github.com/vagabond2003/smart-campus/blob/main/src/shell/ShellMenus.tsx"
click node_seed "https://github.com/vagabond2003/smart-campus/blob/main/src/data/seed.ts"
click node_store "https://github.com/vagabond2003/smart-campus/blob/main/src/api/store.ts"
click node_selectors "https://github.com/vagabond2003/smart-campus/blob/main/src/api/derive.ts"
click node_queries "https://github.com/vagabond2003/smart-campus/blob/main/src/api/hooks.ts"
click node_cloud "https://github.com/vagabond2003/smart-campus/blob/main/src/api/cloud.ts"
click node_firebase "https://github.com/vagabond2003/smart-campus/blob/main/src/lib/firebase.ts"
click node_clock "https://github.com/vagabond2003/smart-campus/blob/main/src/lib/clock.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_router,node_auth,node_shell toneBlue
class node_dashboard,node_course,node_attendance,node_results,node_routine,node_exam,node_admit toneAmber
class node_registration,node_rib,node_bills,node_profile,node_receipt,node_notices toneMint
class node_seed,node_store,node_selectors,node_queries,node_cloud,node_firebase,node_clock toneRose
class node_student toneIndigo
```

## Components

### Access and navigation

- [Route access](https://github.com/vagabond2003/smart-campus/blob/main/src/app/router.tsx): `src/app/router.tsx`
- [Sign-in and activation](https://github.com/vagabond2003/smart-campus/blob/main/src/app/auth.tsx): `src/app/auth.tsx`
- [Portal shell](https://github.com/vagabond2003/smart-campus/blob/main/src/shell/AppShell.tsx): `src/shell/AppShell.tsx`

### Academic services

- [Dashboard](https://github.com/vagabond2003/smart-campus/blob/main/src/pages/Dashboard.tsx): `src/pages/Dashboard.tsx`
- [Courses and discussion](https://github.com/vagabond2003/smart-campus/blob/main/src/pages/course/CourseTab.tsx): `src/pages/course/CourseTab.tsx`
- [Attendance](https://github.com/vagabond2003/smart-campus/blob/main/src/pages/AttendanceSummary.tsx): `src/pages/AttendanceSummary.tsx`
- [Results and CGPA](https://github.com/vagabond2003/smart-campus/blob/main/src/pages/Results.tsx): `src/pages/Results.tsx`
- [Class routine](https://github.com/vagabond2003/smart-campus/blob/main/src/pages/ClassRoutine.tsx): `src/pages/ClassRoutine.tsx`
- [Exam schedule](https://github.com/vagabond2003/smart-campus/blob/main/src/pages/ExamRoutine.tsx): `src/pages/ExamRoutine.tsx`
- [Admit card](https://github.com/vagabond2003/smart-campus/blob/main/src/pages/AdmitCard.tsx): `src/pages/AdmitCard.tsx`

### Student actions

- [Course registration](https://github.com/vagabond2003/smart-campus/blob/main/src/pages/RegularRegistration.tsx): `src/pages/RegularRegistration.tsx`
- [RIB registration](https://github.com/vagabond2003/smart-campus/blob/main/src/pages/RibRegistration.tsx): `src/pages/RibRegistration.tsx`
- [Bills and payments](https://github.com/vagabond2003/smart-campus/blob/main/src/pages/Bills.tsx): `src/pages/Bills.tsx`
- [Student profile](https://github.com/vagabond2003/smart-campus/blob/main/src/pages/Profile.tsx): `src/pages/Profile.tsx`
- [Payment receipt](https://github.com/vagabond2003/smart-campus/blob/main/src/pages/Receipt.tsx): `src/pages/Receipt.tsx`
- [Notifications](https://github.com/vagabond2003/smart-campus/blob/main/src/shell/ShellMenus.tsx): `src/shell/ShellMenus.tsx`

### Data and persistence

- [Synthetic academic data](https://github.com/vagabond2003/smart-campus/blob/main/src/data/seed.ts): `src/data/seed.ts`
- [Student in-memory store](https://github.com/vagabond2003/smart-campus/blob/main/src/api/store.ts): `src/api/store.ts`
- [Academic selectors](https://github.com/vagabond2003/smart-campus/blob/main/src/api/derive.ts): `src/api/derive.ts`
- [Query and mutation hooks](https://github.com/vagabond2003/smart-campus/blob/main/src/api/hooks.ts): `src/api/hooks.ts`
- [Cloud persistence](https://github.com/vagabond2003/smart-campus/blob/main/src/api/cloud.ts): `src/api/cloud.ts`
- [Firebase services](https://github.com/vagabond2003/smart-campus/blob/main/src/lib/firebase.ts): `src/lib/firebase.ts`
- [Academic clock](https://github.com/vagabond2003/smart-campus/blob/main/src/lib/clock.ts): `src/lib/clock.ts`

### Other components

- **Student**

## Connections

- Student → Route access: opens pages (evidence: `src/app/router.tsx`)
- Route access → Sign-in and activation: guards routes (evidence: `src/app/router.tsx`)
- Route access → Portal shell: renders (evidence: `src/app/router.tsx`)
- Route access → Dashboard: routes to (evidence: `src/app/router.tsx`)
- Route access → Courses and discussion: routes to (evidence: `src/app/router.tsx`)
- Route access → Attendance: routes to (evidence: `src/app/router.tsx`)
- Route access → Results and CGPA: routes to (evidence: `src/app/router.tsx`)
- Route access → Class routine: routes to (evidence: `src/app/router.tsx`)
- Route access → Exam schedule: routes to (evidence: `src/app/router.tsx`)
- Route access → Admit card: routes to (evidence: `src/app/router.tsx`)
- Route access → Course registration: routes to (evidence: `src/app/router.tsx`)
- Route access → RIB registration: routes to (evidence: `src/app/router.tsx`)
- Route access → Bills and payments: routes to (evidence: `src/app/router.tsx`)
- Route access → Student profile: routes to (evidence: `src/app/router.tsx`)
- Route access → Payment receipt: routes to (evidence: `src/app/router.tsx`)
- Sign-in and activation → Cloud persistence: loads profile (evidence: `src/app/auth.tsx`)
- Sign-in and activation → Cloud persistence: creates profile (evidence: `src/app/auth.tsx`)
- Sign-in and activation → Firebase services: authenticates (evidence: `src/app/auth.tsx`)
- Query and mutation hooks → Synthetic academic data: reads shared data (evidence: `src/api/hooks.ts`)
- Query and mutation hooks → Student in-memory store: reads and mutates (evidence: `src/api/hooks.ts`)
- Query and mutation hooks → Academic selectors: computes views (evidence: `src/api/hooks.ts`)
- Query and mutation hooks → Cloud persistence: persists mutations (evidence: `src/api/hooks.ts`)
- Cloud persistence → Firebase services: uses services (evidence: `src/api/cloud.ts`)
- Student in-memory store → Synthetic academic data: initializes from (evidence: `src/api/store.ts`)
- Academic selectors → Synthetic academic data: derives from (evidence: `src/api/derive.ts`)
- Synthetic academic data → Academic clock: anchors dates (evidence: `src/data/seed.ts`)
- Academic selectors → Academic clock: uses calendar (evidence: `src/api/derive.ts`)
- Dashboard → Query and mutation hooks: loads data (evidence: `src/pages/Dashboard.tsx`)
- Courses and discussion → Query and mutation hooks: loads data (evidence: `src/pages/course/CourseTab.tsx`)
- Bills and payments → Query and mutation hooks: loads and mutates (evidence: `src/pages/Bills.tsx`)
- Results and CGPA → Query and mutation hooks: loads data (evidence: `src/pages/Results.tsx`)
- Portal shell → Notifications: includes menus
- RIB registration → Query and mutation hooks: registers
- Course registration → Query and mutation hooks: loads options
- Attendance → Query and mutation hooks: loads data
- Class routine → Query and mutation hooks: loads data
- Exam schedule → Query and mutation hooks: loads data
- Admit card → Query and mutation hooks: loads data
- Student profile → Query and mutation hooks: loads data
- Payment receipt → Bills and payments: shows payment
