# welearnyoulearn/prototype architecture

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

- Interactive diagram: https://gitdiagram.com/welearnyoulearn/prototype
- Repository: https://github.com/welearnyoulearn/prototype

## Overview

WLYL is a multi-tenant school-management platform with Platform Admin, School Admin, Teacher, Student, and Parent portals; school access is limited by plan features and per-school overrides. The tree shows school operations spanning attendance, students, exams, syllabus, fees, announcements, feedback, and academic-year rollover, plus platform administration and exports. The sampled routes and source index support several internal calls and the database layer. Many feature-specific routes are unsampled, so their implementation links are omitted rather than inferred.

Main entry points: [`lib/db.ts`](https://github.com/welearnyoulearn/prototype/blob/dev/lib/db.ts) (PostgreSQL database), [`app/api/students/route.ts`](https://github.com/welearnyoulearn/prototype/blob/dev/app/api/students/route.ts) (Student records), [`lib/dataExport/service.ts`](https://github.com/welearnyoulearn/prototype/blob/dev/lib/dataExport/service.ts) (Data exports), [`lib/auth.ts`](https://github.com/welearnyoulearn/prototype/blob/dev/lib/auth.ts) (Portal identity)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_portals["User portals"]
  node_school_admin["School Admin<br/>[page.tsx]"]
  node_teacher["Teacher<br/>[page.tsx]"]
  node_student["Student<br/>[page.tsx]"]
  node_parent["Parent<br/>[page.tsx]"]
  node_platform_admin["Platform Admin<br/>[page.tsx]"]
end

subgraph group_operations["School operations"]
  node_students["Student records<br/>[route.ts]"]
  node_student_setup["Student onboarding"]
  node_attendance["Attendance<br/>[route.ts]"]
  node_attendance_rules["Attendance rules<br/>[attendanceRules.ts]"]
  node_exams["Exams and marks<br/>[route.ts]"]
  node_syllabus["Syllabus tracking<br/>[route.ts]"]
  node_fees["Fees and year-end<br/>[route.ts]"]
  node_announcements["Announcements<br/>[route.ts]"]
  node_feedback["Feedback<br/>[route.ts]"]
  node_academic_year["Academic years<br/>[route.ts]"]
end

subgraph group_platform["Platform services"]
  node_exports["Data exports<br/>[service.ts]"]
  node_export_render["Export rendering<br/>[render.ts]"]
end

subgraph group_shared["Shared runtime"]
  node_identity["Portal identity<br/>[auth.ts]"]
  node_plan_access["Feature access<br/>[features.ts]"]
  node_database[("PostgreSQL database<br/>[db.ts]")]
end

node_actors(("School users"))

node_actors -->|"use portal"| node_school_admin
node_actors -->|"use portal"| node_teacher
node_actors -->|"use portal"| node_student
node_actors -->|"use portal"| node_parent
node_actors -->|"use portal"| node_platform_admin
node_students -->|"checks session"| node_identity
node_students -->|"checks features"| node_plan_access
node_students -->|"creates parent"| node_student_setup
node_attendance -->|"uses date rules"| node_attendance_rules
node_attendance -->|"queries data"| node_database
node_exams -->|"queries data"| node_database
node_syllabus -->|"queries data"| node_database
node_fees -->|"queries data"| node_database
node_academic_year -->|"queries data"| node_database
node_exports -->|"checks features"| node_identity
node_exports -->|"renders files"| node_export_render
node_exports -->|"reads records"| node_database
node_identity -->|"reads sessions"| node_database

click node_school_admin "https://github.com/welearnyoulearn/prototype/blob/dev/app/school-admin/page.tsx"
click node_teacher "https://github.com/welearnyoulearn/prototype/blob/dev/app/teacher/page.tsx"
click node_student "https://github.com/welearnyoulearn/prototype/blob/dev/app/student/page.tsx"
click node_parent "https://github.com/welearnyoulearn/prototype/blob/dev/app/parent/page.tsx"
click node_platform_admin "https://github.com/welearnyoulearn/prototype/blob/dev/app/platform-admin/page.tsx"
click node_identity "https://github.com/welearnyoulearn/prototype/blob/dev/lib/auth.ts"
click node_plan_access "https://github.com/welearnyoulearn/prototype/blob/dev/lib/features.ts"
click node_students "https://github.com/welearnyoulearn/prototype/blob/dev/app/api/students/route.ts"
click node_student_setup "https://github.com/welearnyoulearn/prototype/blob/dev/lib/studentOnboarding.ts"
click node_attendance "https://github.com/welearnyoulearn/prototype/blob/dev/app/api/attendance/route.ts"
click node_attendance_rules "https://github.com/welearnyoulearn/prototype/blob/dev/lib/attendanceRules.ts"
click node_exams "https://github.com/welearnyoulearn/prototype/blob/dev/app/api/exams/schedule/route.ts"
click node_syllabus "https://github.com/welearnyoulearn/prototype/blob/dev/app/api/syllabus/route.ts"
click node_fees "https://github.com/welearnyoulearn/prototype/blob/dev/app/api/fees/year-end/route.ts"
click node_announcements "https://github.com/welearnyoulearn/prototype/blob/dev/app/api/announcements/route.ts"
click node_feedback "https://github.com/welearnyoulearn/prototype/blob/dev/app/api/feedback/submit/route.ts"
click node_academic_year "https://github.com/welearnyoulearn/prototype/blob/dev/app/api/academic-years/route.ts"
click node_exports "https://github.com/welearnyoulearn/prototype/blob/dev/lib/dataExport/service.ts"
click node_export_render "https://github.com/welearnyoulearn/prototype/blob/dev/lib/dataExport/render.ts"
click node_database "https://github.com/welearnyoulearn/prototype/blob/dev/lib/db.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_school_admin,node_teacher,node_student,node_parent,node_platform_admin,node_actors toneBlue
class node_students,node_student_setup,node_attendance,node_attendance_rules,node_exams,node_syllabus,node_fees,node_announcements,node_feedback,node_academic_year toneAmber
class node_exports,node_export_render toneMint
class node_identity,node_plan_access,node_database toneRose
```

## Components

### User portals

- [School Admin](https://github.com/welearnyoulearn/prototype/blob/dev/app/school-admin/page.tsx): `app/school-admin/page.tsx`
- [Teacher](https://github.com/welearnyoulearn/prototype/blob/dev/app/teacher/page.tsx): `app/teacher/page.tsx`
- [Student](https://github.com/welearnyoulearn/prototype/blob/dev/app/student/page.tsx): `app/student/page.tsx`
- [Parent](https://github.com/welearnyoulearn/prototype/blob/dev/app/parent/page.tsx): `app/parent/page.tsx`
- [Platform Admin](https://github.com/welearnyoulearn/prototype/blob/dev/app/platform-admin/page.tsx): `app/platform-admin/page.tsx`

### School operations

- [Student records](https://github.com/welearnyoulearn/prototype/blob/dev/app/api/students/route.ts): `app/api/students/route.ts`
- [Student onboarding](https://github.com/welearnyoulearn/prototype/blob/dev/lib/studentOnboarding.ts): `lib/studentOnboarding.ts`
- [Attendance](https://github.com/welearnyoulearn/prototype/blob/dev/app/api/attendance/route.ts): `app/api/attendance/route.ts`
- [Attendance rules](https://github.com/welearnyoulearn/prototype/blob/dev/lib/attendanceRules.ts): `lib/attendanceRules.ts`
- [Exams and marks](https://github.com/welearnyoulearn/prototype/blob/dev/app/api/exams/schedule/route.ts): `app/api/exams/schedule/route.ts`
- [Syllabus tracking](https://github.com/welearnyoulearn/prototype/blob/dev/app/api/syllabus/route.ts): `app/api/syllabus/route.ts`
- [Fees and year-end](https://github.com/welearnyoulearn/prototype/blob/dev/app/api/fees/year-end/route.ts): `app/api/fees/year-end/route.ts`
- [Announcements](https://github.com/welearnyoulearn/prototype/blob/dev/app/api/announcements/route.ts): `app/api/announcements/route.ts`
- [Feedback](https://github.com/welearnyoulearn/prototype/blob/dev/app/api/feedback/submit/route.ts): `app/api/feedback/submit/route.ts`
- [Academic years](https://github.com/welearnyoulearn/prototype/blob/dev/app/api/academic-years/route.ts): `app/api/academic-years/route.ts`

### Platform services

- [Data exports](https://github.com/welearnyoulearn/prototype/blob/dev/lib/dataExport/service.ts): `lib/dataExport/service.ts`
- [Export rendering](https://github.com/welearnyoulearn/prototype/blob/dev/lib/dataExport/render.ts): `lib/dataExport/render.ts`

### Shared runtime

- [Portal identity](https://github.com/welearnyoulearn/prototype/blob/dev/lib/auth.ts): `lib/auth.ts`
- [Feature access](https://github.com/welearnyoulearn/prototype/blob/dev/lib/features.ts): `lib/features.ts`
- [PostgreSQL database](https://github.com/welearnyoulearn/prototype/blob/dev/lib/db.ts): `lib/db.ts`

### Other components

- **School users**

## Connections

- School users → School Admin: use portal (evidence: `README.md`)
- School users → Teacher: use portal (evidence: `README.md`)
- School users → Student: use portal (evidence: `README.md`)
- School users → Parent: use portal (evidence: `README.md`)
- School users → Platform Admin: use portal (evidence: `README.md`)
- Student records → Portal identity: checks session (evidence: `app/api/students/route.ts`)
- Student records → Feature access: checks features (evidence: `app/api/students/route.ts`)
- Student records → Student onboarding: creates parent (evidence: `app/api/students/route.ts`)
- Attendance → Attendance rules: uses date rules (evidence: `app/api/attendance/route.ts`)
- Attendance → PostgreSQL database: queries data (evidence: `app/api/attendance/route.ts`)
- Exams and marks → PostgreSQL database: queries data (evidence: `app/api/exams/schedule/route.ts`)
- Syllabus tracking → PostgreSQL database: queries data (evidence: `app/api/syllabus/route.ts`)
- Fees and year-end → PostgreSQL database: queries data (evidence: `app/api/fees/year-end/route.ts`)
- Academic years → PostgreSQL database: queries data (evidence: `app/api/academic-years/route.ts`)
- Data exports → Portal identity: checks features (evidence: `lib/dataExport/service.ts`)
- Data exports → Export rendering: renders files (evidence: `lib/dataExport/service.ts`)
- Data exports → PostgreSQL database: reads records (evidence: `lib/dataExport/service.ts`)
- Portal identity → PostgreSQL database: reads sessions (evidence: `lib/auth.ts`)
