# shubhagrawal666/quyl architecture

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

## Overview

Quyl is a full-stack learning platform. Students register and verify by email, browse courses, enroll, and track lesson completion; administrators manage courses, lessons, users, and platform statistics. The React client calls an Express API, whose controllers apply authentication and role checks and use MongoDB models for persistent state. The README documents the major capabilities, while the shown source excerpts establish key API routing and controller-to-model calls; some page-to-endpoint and unsampled admin relationships are therefore documented rather than source-verified.

Main entry points: [`server/server.js`](https://github.com/shubhagrawal666/quyl/blob/main/server/server.js) (Express Server), [`server/controllers/courseController.js`](https://github.com/shubhagrawal666/quyl/blob/main/server/controllers/courseController.js) (Course Logic), [`server/controllers/adminController.js`](https://github.com/shubhagrawal666/quyl/blob/main/server/controllers/adminController.js) (Admin Logic), [`server/middleware/authMiddleware.js`](https://github.com/shubhagrawal666/quyl/blob/main/server/middleware/authMiddleware.js) (Auth Guard)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["Student Experience"]
  node_app["Client App<br/>[App.jsx]"]
  node_authui["Account Screens"]
  node_authstate["Auth Context<br/>[AuthContext.jsx]"]
  node_catalog["Course Catalog<br/>[AllCourses.jsx]"]
  node_details["Course Details<br/>[CourseDetails.jsx]"]
  node_learning["My Courses<br/>[MyCourses.jsx]"]
  node_authapi["Auth API Client<br/>[auth.js]"]
  node_courseapi["Course API Client<br/>[courses.js]"]
end

subgraph group_admin["Administration"]
  node_adminui["Admin Console"]
  node_adminapi["Admin API Client<br/>[admin.js]"]
end

subgraph group_api["API Services"]
  node_server["Express Server<br/>[server.js]"]
  node_authroutes["Auth Routes<br/>[authRoutes.js]"]
  node_courseroutes["Course Routes<br/>[courseRoutes.js]"]
  node_adminroutes["Admin Routes<br/>[adminRoutes.js]"]
  node_authcontroller["Account Logic<br/>[authController.js]"]
  node_coursecontroller["Course Logic"]
  node_admincontroller["Admin Logic<br/>[adminController.js]"]
  node_authguard["Auth Guard<br/>[authMiddleware.js]"]
  node_rolecheck["Role Check<br/>[roleMiddleware.js]"]
  node_mailer["Email Transport<br/>[nodemailer.js]"]
end

subgraph group_data["Persistence"]
  node_users[("User Records<br/>[userModel.js]")]
  node_courses[("Course Records<br/>[courseModel.js]")]
  node_progress[("Progress Records<br/>[ProgressModel.js]")]
  node_mongodb["MongoDB Connector<br/>[mongodb.js]"]
end

node_student(("Student"))
node_email["Email Service"]

node_student -->|"uses"| node_app
node_app -.->|"presents"| node_authui
node_authui -.->|"submits account"| node_authapi
node_authui -->|"updates session"| node_authstate
node_authstate -->|"checks session"| node_authroutes
node_student -->|"browses"| node_catalog
node_catalog -->|"requests courses"| node_courseapi
node_student -->|"selects course"| node_details
node_details -->|"loads course"| node_courseapi
node_student -->|"tracks learning"| node_learning
node_learning -->|"requests progress"| node_courseapi
node_authapi -->|"calls API"| node_server
node_courseapi -->|"calls API"| node_server
node_adminui -->|"manages platform"| node_adminapi
node_adminapi -.->|"calls API"| node_server
node_server -->|"mounts routes"| node_authroutes
node_server -->|"mounts routes"| node_courseroutes
node_server -->|"mounts routes"| node_adminroutes
node_authroutes -->|"dispatches"| node_authcontroller
node_courseroutes -->|"dispatches"| node_coursecontroller
node_adminroutes -->|"dispatches"| node_admincontroller
node_authroutes -->|"guards session check"| node_authguard
node_courseroutes -->|"guards protected routes"| node_authguard
node_courseroutes -->|"guards admin routes"| node_rolecheck
node_adminroutes -->|"guards admin routes"| node_authguard
node_adminroutes -->|"checks admin role"| node_rolecheck
node_authcontroller -->|"reads and writes"| node_users
node_authcontroller -->|"sends OTP"| node_mailer
node_mailer -->|"delivers messages"| node_email
node_coursecontroller -->|"reads and writes"| node_courses
node_coursecontroller -->|"updates enrollment"| node_users
node_coursecontroller -->|"tracks completion"| node_progress
node_admincontroller -->|"manages users"| node_users
node_admincontroller -->|"reads course stats"| node_courses
node_admincontroller -->|"reads progress"| node_progress
node_authcontroller -->|"connects database"| node_mongodb
node_coursecontroller -->|"connects database"| node_mongodb
node_admincontroller -->|"connects database"| node_mongodb
node_authguard -->|"loads account"| node_users
node_authguard -->|"connects database"| node_mongodb

click node_app "https://github.com/shubhagrawal666/quyl/blob/main/client/src/App.jsx"
click node_authui "https://github.com/shubhagrawal666/quyl/tree/main/client/src/components/Auth"
click node_authstate "https://github.com/shubhagrawal666/quyl/blob/main/client/src/context/AuthContext.jsx"
click node_catalog "https://github.com/shubhagrawal666/quyl/blob/main/client/src/components/courses/AllCourses.jsx"
click node_details "https://github.com/shubhagrawal666/quyl/blob/main/client/src/components/courses/CourseDetails.jsx"
click node_learning "https://github.com/shubhagrawal666/quyl/blob/main/client/src/components/myCourses/MyCourses.jsx"
click node_authapi "https://github.com/shubhagrawal666/quyl/blob/main/client/src/api/auth.js"
click node_courseapi "https://github.com/shubhagrawal666/quyl/blob/main/client/src/api/courses.js"
click node_adminui "https://github.com/shubhagrawal666/quyl/tree/main/client/src/components/admin"
click node_adminapi "https://github.com/shubhagrawal666/quyl/blob/main/client/src/api/admin.js"
click node_server "https://github.com/shubhagrawal666/quyl/blob/main/server/server.js"
click node_authroutes "https://github.com/shubhagrawal666/quyl/blob/main/server/routes/authRoutes.js"
click node_courseroutes "https://github.com/shubhagrawal666/quyl/blob/main/server/routes/courseRoutes.js"
click node_adminroutes "https://github.com/shubhagrawal666/quyl/blob/main/server/routes/adminRoutes.js"
click node_authcontroller "https://github.com/shubhagrawal666/quyl/blob/main/server/controllers/authController.js"
click node_coursecontroller "https://github.com/shubhagrawal666/quyl/blob/main/server/controllers/courseController.js"
click node_admincontroller "https://github.com/shubhagrawal666/quyl/blob/main/server/controllers/adminController.js"
click node_authguard "https://github.com/shubhagrawal666/quyl/blob/main/server/middleware/authMiddleware.js"
click node_rolecheck "https://github.com/shubhagrawal666/quyl/blob/main/server/middleware/roleMiddleware.js"
click node_users "https://github.com/shubhagrawal666/quyl/blob/main/server/models/userModel.js"
click node_courses "https://github.com/shubhagrawal666/quyl/blob/main/server/models/courseModel.js"
click node_progress "https://github.com/shubhagrawal666/quyl/blob/main/server/models/ProgressModel.js"
click node_mongodb "https://github.com/shubhagrawal666/quyl/blob/main/server/config/mongodb.js"
click node_mailer "https://github.com/shubhagrawal666/quyl/blob/main/server/config/nodemailer.js"

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_authstate,node_catalog,node_details,node_learning,node_authapi,node_courseapi toneBlue
class node_adminui,node_adminapi toneAmber
class node_server,node_authroutes,node_courseroutes,node_adminroutes,node_authcontroller,node_coursecontroller,node_admincontroller,node_authguard,node_rolecheck,node_mailer toneMint
class node_users,node_courses,node_progress,node_mongodb toneRose
class node_student,node_email toneIndigo
```

## Components

### Student Experience

- [Client App](https://github.com/shubhagrawal666/quyl/blob/main/client/src/App.jsx): `client/src/App.jsx`
- [Account Screens](https://github.com/shubhagrawal666/quyl/tree/main/client/src/components/Auth): `client/src/components/Auth`
- [Auth Context](https://github.com/shubhagrawal666/quyl/blob/main/client/src/context/AuthContext.jsx): `client/src/context/AuthContext.jsx`
- [Course Catalog](https://github.com/shubhagrawal666/quyl/blob/main/client/src/components/courses/AllCourses.jsx): `client/src/components/courses/AllCourses.jsx`
- [Course Details](https://github.com/shubhagrawal666/quyl/blob/main/client/src/components/courses/CourseDetails.jsx): `client/src/components/courses/CourseDetails.jsx`
- [My Courses](https://github.com/shubhagrawal666/quyl/blob/main/client/src/components/myCourses/MyCourses.jsx): `client/src/components/myCourses/MyCourses.jsx`
- [Auth API Client](https://github.com/shubhagrawal666/quyl/blob/main/client/src/api/auth.js): `client/src/api/auth.js`
- [Course API Client](https://github.com/shubhagrawal666/quyl/blob/main/client/src/api/courses.js): `client/src/api/courses.js`

### Administration

- [Admin Console](https://github.com/shubhagrawal666/quyl/tree/main/client/src/components/admin): `client/src/components/admin`
- [Admin API Client](https://github.com/shubhagrawal666/quyl/blob/main/client/src/api/admin.js): `client/src/api/admin.js`

### API Services

- [Express Server](https://github.com/shubhagrawal666/quyl/blob/main/server/server.js): `server/server.js`
- [Auth Routes](https://github.com/shubhagrawal666/quyl/blob/main/server/routes/authRoutes.js): `server/routes/authRoutes.js`
- [Course Routes](https://github.com/shubhagrawal666/quyl/blob/main/server/routes/courseRoutes.js): `server/routes/courseRoutes.js`
- [Admin Routes](https://github.com/shubhagrawal666/quyl/blob/main/server/routes/adminRoutes.js): `server/routes/adminRoutes.js`
- [Account Logic](https://github.com/shubhagrawal666/quyl/blob/main/server/controllers/authController.js): `server/controllers/authController.js`
- [Course Logic](https://github.com/shubhagrawal666/quyl/blob/main/server/controllers/courseController.js): `server/controllers/courseController.js`
- [Admin Logic](https://github.com/shubhagrawal666/quyl/blob/main/server/controllers/adminController.js): `server/controllers/adminController.js`
- [Auth Guard](https://github.com/shubhagrawal666/quyl/blob/main/server/middleware/authMiddleware.js): `server/middleware/authMiddleware.js`
- [Role Check](https://github.com/shubhagrawal666/quyl/blob/main/server/middleware/roleMiddleware.js): `server/middleware/roleMiddleware.js`
- [Email Transport](https://github.com/shubhagrawal666/quyl/blob/main/server/config/nodemailer.js): `server/config/nodemailer.js`

### Persistence

- [User Records](https://github.com/shubhagrawal666/quyl/blob/main/server/models/userModel.js): `server/models/userModel.js`
- [Course Records](https://github.com/shubhagrawal666/quyl/blob/main/server/models/courseModel.js): `server/models/courseModel.js`
- [Progress Records](https://github.com/shubhagrawal666/quyl/blob/main/server/models/ProgressModel.js): `server/models/ProgressModel.js`
- [MongoDB Connector](https://github.com/shubhagrawal666/quyl/blob/main/server/config/mongodb.js): `server/config/mongodb.js`

### Other components

- **Student**
- **Email Service**

## Connections

- Student → Client App: uses (evidence: `README.md`)
- Client App → Account Screens: presents
- Account Screens → Auth API Client: submits account (evidence: `client/src/components/Auth/Profile.jsx`)
- Account Screens → Auth Context: updates session (evidence: `client/src/components/Auth/Profile.jsx`)
- Auth Context → Auth Routes: checks session (evidence: `client/src/context/AuthContext.jsx`)
- Student → Course Catalog: browses (evidence: `README.md`)
- Course Catalog → Course API Client: requests courses (evidence: `client/src/components/courses/AllCourses.jsx`)
- Student → Course Details: selects course (evidence: `README.md`)
- Course Details → Course API Client: loads course (evidence: `client/src/components/courses/CourseDetails.jsx`)
- Student → My Courses: tracks learning (evidence: `README.md`)
- My Courses → Course API Client: requests progress (evidence: `client/src/components/myCourses/MyCourses.jsx`)
- Auth API Client → Express Server: calls API (evidence: `README.md`)
- Course API Client → Express Server: calls API (evidence: `README.md`)
- Admin Console → Admin API Client: manages platform (evidence: `client/src/components/admin/AdminDashboard.jsx`)
- Admin API Client → Express Server: calls API
- Express Server → Auth Routes: mounts routes (evidence: `server/server.js`)
- Express Server → Course Routes: mounts routes (evidence: `server/server.js`)
- Express Server → Admin Routes: mounts routes (evidence: `server/server.js`)
- Auth Routes → Account Logic: dispatches (evidence: `server/routes/authRoutes.js`)
- Course Routes → Course Logic: dispatches (evidence: `server/routes/courseRoutes.js`)
- Admin Routes → Admin Logic: dispatches (evidence: `server/routes/adminRoutes.js`)
- Auth Routes → Auth Guard: guards session check (evidence: `server/routes/authRoutes.js`)
- Course Routes → Auth Guard: guards protected routes (evidence: `server/routes/courseRoutes.js`)
- Course Routes → Role Check: guards admin routes (evidence: `server/routes/courseRoutes.js`)
- Admin Routes → Auth Guard: guards admin routes (evidence: `server/routes/adminRoutes.js`)
- Admin Routes → Role Check: checks admin role (evidence: `server/routes/adminRoutes.js`)
- Account Logic → User Records: reads and writes (evidence: `server/controllers/authController.js`)
- Account Logic → Email Transport: sends OTP (evidence: `server/controllers/authController.js`)
- Email Transport → Email Service: delivers messages (evidence: `README.md`)
- Course Logic → Course Records: reads and writes (evidence: `server/controllers/courseController.js`)
- Course Logic → User Records: updates enrollment (evidence: `server/controllers/courseController.js`)
- Course Logic → Progress Records: tracks completion (evidence: `server/controllers/courseController.js`)
- Admin Logic → User Records: manages users (evidence: `server/controllers/adminController.js`)
- Admin Logic → Course Records: reads course stats (evidence: `server/controllers/adminController.js`)
- Admin Logic → Progress Records: reads progress (evidence: `server/controllers/adminController.js`)
- Account Logic → MongoDB Connector: connects database (evidence: `server/controllers/authController.js`)
- Course Logic → MongoDB Connector: connects database (evidence: `server/controllers/courseController.js`)
- Admin Logic → MongoDB Connector: connects database (evidence: `server/controllers/adminController.js`)
- Auth Guard → User Records: loads account (evidence: `server/middleware/authMiddleware.js`)
- Auth Guard → MongoDB Connector: connects database (evidence: `server/middleware/authMiddleware.js`)
