# nhutquoc2910/uni-class-android architecture

> Architecture diagram of the GitHub repository nhutquoc2910/uni-class-android, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-17). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/nhutquoc2910/uni-class-android
- Repository: https://github.com/nhutquoc2910/uni-class-android

## Overview

Uni-Class is an Android client for university classes, coursework, and attendance, serving students and lecturers. Users authenticate and are routed to role-specific interfaces; they then manage or participate in classes, assignments, schedules, and attendance, with results fetched from the service API and presented in the app. The graph preserves the documented student and lecturer workflows plus shared authentication, persistence, and notification capabilities. Some feature relationships come from the README; unsampled implementation details are not asserted as inspected.

Main entry points: [`app/src/main/java/com/ppquang06/uniclassapp/ui/student/StudentMainActivity.java`](https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/ui/student/StudentMainActivity.java) (Student app shell), [`app/src/main/java/com/ppquang06/uniclassapp/ui/lecturer/LecturerMainActivity.java`](https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/ui/lecturer/LecturerMainActivity.java) (Lecturer app shell), [`app/src/main/java/com/ppquang06/uniclassapp/utils/RoleRouter.java`](https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/utils/RoleRouter.java) (Role routing), [`app/src/main/java/com/ppquang06/uniclassapp/ui/lecturer/attendance/AttendanceViewModel.java`](https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/ui/lecturer/attendance/AttendanceViewModel.java) (Live QR sessions)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Entry and session"]
  node_auth["Authentication screens"]
  node_authvm["Auth state<br/>[AuthViewModel.java]"]
  node_role["Role routing<br/>[RoleRouter.java]"]
  node_session[("Session storage")]
end

subgraph group_learning["Student learning"]
  node_student["Student app shell"]
  node_studentclasses["Classes and materials"]
  node_studentwork["Assignments and grades"]
  node_studentattendance["QR check-in"]
  node_studenthome["Home and schedule"]
end

subgraph group_teaching["Lecturer tools"]
  node_lecturer["Lecturer app shell"]
  node_lecturerclasses["Class management"]
  node_lecturerwork["Assignment grading"]
  node_lecturerattendance["Live QR sessions"]
  node_lecturerqr["QR display"]
end

subgraph group_shared["Shared services"]
  node_homevm["Home state<br/>[HomeViewModel.java]"]
  node_schedule["Semester schedule"]
  node_notifications["Push notifications"]
end

subgraph group_data["Data and integration"]
  node_api["Class and user API"]
  node_authapi["Authentication API"]
  node_repos["Repositories"]
  node_room[("Room cache")]
  node_websocket["Realtime WebSocket"]
end

node_user(("Student or lecturer"))
node_external{{"Uni-Class service"}}
node_fcm{{"Firebase Cloud Messaging"}}

node_user -->|"signs in"| node_auth
node_auth -->|"submits credentials"| node_authvm
node_authvm -.->|"requests auth"| node_authapi
node_authapi -->|"calls auth endpoints"| node_external
node_user -->|"enters app"| node_role
node_role -->|"routes student"| node_student
node_role -.->|"routes lecturer"| node_lecturer
node_student -.->|"opens classes"| node_studentclasses
node_student -.->|"opens home"| node_studenthome
node_student -.->|"opens QR scan"| node_studentattendance
node_studentclasses -.->|"joins and retrieves classes"| node_external
node_studentwork -.->|"submits coursework"| node_external
node_studentattendance -.->|"checks in"| node_external
node_studenthome -.->|"loads home data"| node_homevm
node_homevm -->|"requests summaries"| node_repos
node_schedule -->|"uses schedule state"| node_homevm
node_lecturer -.->|"opens class tools"| node_lecturerclasses
node_lecturer -.->|"opens grading"| node_lecturerwork
node_lecturer -.->|"opens attendance"| node_lecturerattendance
node_lecturerattendance -->|"starts QR session"| node_lecturerqr
node_lecturerclasses -.->|"manages classes"| node_external
node_lecturerwork -.->|"grades submissions"| node_external
node_lecturerqr -.->|"opens attendance session"| node_external
node_lecturerattendance -.->|"receives live updates"| node_websocket
node_repos -.->|"uses endpoints"| node_api
node_api -->|"calls class endpoints"| node_external
node_repos -.->|"caches data"| node_room
node_external -.->|"sends push events"| node_fcm
node_fcm -->|"delivers messages"| node_notifications
node_notifications -->|"saves device token"| node_session

click node_auth "https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/RegisterActivity.java"
click node_authvm "https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/ui/auth/AuthViewModel.java"
click node_role "https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/utils/RoleRouter.java"
click node_session "https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/utils/SessionManager.java"
click node_student "https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/ui/student/StudentMainActivity.java"
click node_studentclasses "https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/ui/student/classes/StudentClassesFragment.java"
click node_studentwork "https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/ui/student/classes/StudentAssignmentViewModel.java"
click node_studentattendance "https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/ui/student/qr/StudentScanQrFragment.java"
click node_studenthome "https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/ui/student/home/StudentHomeFragment.java"
click node_lecturer "https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/ui/lecturer/LecturerMainActivity.java"
click node_lecturerclasses "https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/ui/lecturer/classes/LecturerManagementViewModel.java"
click node_lecturerwork "https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/ui/lecturer/assignments/GradingViewModel.java"
click node_lecturerattendance "https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/ui/lecturer/attendance/AttendanceViewModel.java"
click node_lecturerqr "https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/ui/lecturer/attendance/LecturerQrSessionFragment.java"
click node_api "https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/data/api/UserClassApiService.java"
click node_authapi "https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/data/api/AuthApiService.java"
click node_repos "https://github.com/nhutquoc2910/uni-class-android/tree/main/app/src/main/java/com/ppquang06/uniclassapp/data/repository"
click node_room "https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/data/local/UniClassDatabase.java"
click node_homevm "https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/ui/common/HomeViewModel.java"
click node_schedule "https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/ui/common/SemesterScheduleFragment.java"
click node_notifications "https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/service/UniClassFirebaseMessagingService.java"
click node_websocket "https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/data/api/StompWebSocketClient.java"

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_auth,node_authvm,node_role,node_session toneBlue
class node_student,node_studentclasses,node_studentwork,node_studentattendance,node_studenthome toneAmber
class node_lecturer,node_lecturerclasses,node_lecturerwork,node_lecturerattendance,node_lecturerqr toneMint
class node_homevm,node_schedule,node_notifications toneRose
class node_api,node_authapi,node_repos,node_room,node_websocket,node_user,node_external,node_fcm toneIndigo
```

## Components

### Entry and session

- [Authentication screens](https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/RegisterActivity.java): `app/src/main/java/com/ppquang06/uniclassapp/RegisterActivity.java`
- [Auth state](https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/ui/auth/AuthViewModel.java): `app/src/main/java/com/ppquang06/uniclassapp/ui/auth/AuthViewModel.java`
- [Role routing](https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/utils/RoleRouter.java): `app/src/main/java/com/ppquang06/uniclassapp/utils/RoleRouter.java`
- [Session storage](https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/utils/SessionManager.java): `app/src/main/java/com/ppquang06/uniclassapp/utils/SessionManager.java`

### Student learning

- [Student app shell](https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/ui/student/StudentMainActivity.java): `app/src/main/java/com/ppquang06/uniclassapp/ui/student/StudentMainActivity.java`
- [Classes and materials](https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/ui/student/classes/StudentClassesFragment.java): `app/src/main/java/com/ppquang06/uniclassapp/ui/student/classes/StudentClassesFragment.java`
- [Assignments and grades](https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/ui/student/classes/StudentAssignmentViewModel.java): `app/src/main/java/com/ppquang06/uniclassapp/ui/student/classes/StudentAssignmentViewModel.java`
- [QR check-in](https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/ui/student/qr/StudentScanQrFragment.java): `app/src/main/java/com/ppquang06/uniclassapp/ui/student/qr/StudentScanQrFragment.java`
- [Home and schedule](https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/ui/student/home/StudentHomeFragment.java): `app/src/main/java/com/ppquang06/uniclassapp/ui/student/home/StudentHomeFragment.java`

### Lecturer tools

- [Lecturer app shell](https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/ui/lecturer/LecturerMainActivity.java): `app/src/main/java/com/ppquang06/uniclassapp/ui/lecturer/LecturerMainActivity.java`
- [Class management](https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/ui/lecturer/classes/LecturerManagementViewModel.java): `app/src/main/java/com/ppquang06/uniclassapp/ui/lecturer/classes/LecturerManagementViewModel.java`
- [Assignment grading](https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/ui/lecturer/assignments/GradingViewModel.java): `app/src/main/java/com/ppquang06/uniclassapp/ui/lecturer/assignments/GradingViewModel.java`
- [Live QR sessions](https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/ui/lecturer/attendance/AttendanceViewModel.java): `app/src/main/java/com/ppquang06/uniclassapp/ui/lecturer/attendance/AttendanceViewModel.java`
- [QR display](https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/ui/lecturer/attendance/LecturerQrSessionFragment.java): `app/src/main/java/com/ppquang06/uniclassapp/ui/lecturer/attendance/LecturerQrSessionFragment.java`

### Shared services

- [Home state](https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/ui/common/HomeViewModel.java): `app/src/main/java/com/ppquang06/uniclassapp/ui/common/HomeViewModel.java`
- [Semester schedule](https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/ui/common/SemesterScheduleFragment.java): `app/src/main/java/com/ppquang06/uniclassapp/ui/common/SemesterScheduleFragment.java`
- [Push notifications](https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/service/UniClassFirebaseMessagingService.java): `app/src/main/java/com/ppquang06/uniclassapp/service/UniClassFirebaseMessagingService.java`

### Data and integration

- [Class and user API](https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/data/api/UserClassApiService.java): `app/src/main/java/com/ppquang06/uniclassapp/data/api/UserClassApiService.java`
- [Authentication API](https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/data/api/AuthApiService.java): `app/src/main/java/com/ppquang06/uniclassapp/data/api/AuthApiService.java`
- [Repositories](https://github.com/nhutquoc2910/uni-class-android/tree/main/app/src/main/java/com/ppquang06/uniclassapp/data/repository): `app/src/main/java/com/ppquang06/uniclassapp/data/repository`
- [Room cache](https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/data/local/UniClassDatabase.java): `app/src/main/java/com/ppquang06/uniclassapp/data/local/UniClassDatabase.java`
- [Realtime WebSocket](https://github.com/nhutquoc2910/uni-class-android/blob/main/app/src/main/java/com/ppquang06/uniclassapp/data/api/StompWebSocketClient.java): `app/src/main/java/com/ppquang06/uniclassapp/data/api/StompWebSocketClient.java`

### Other components

- **Student or lecturer**
- **Uni-Class service**
- **Firebase Cloud Messaging**

## Connections

- Student or lecturer → Authentication screens: signs in (evidence: `app/src/main/java/com/ppquang06/uniclassapp/RegisterActivity.java`)
- Authentication screens → Auth state: submits credentials (evidence: `app/src/main/java/com/ppquang06/uniclassapp/RegisterActivity.java`)
- Auth state → Authentication API: requests auth
- Authentication API → Uni-Class service: calls auth endpoints (evidence: `app/src/main/java/com/ppquang06/uniclassapp/data/api/AuthApiService.java`)
- Student or lecturer → Role routing: enters app
- Role routing → Student app shell: routes student (evidence: `app/src/main/java/com/ppquang06/uniclassapp/ui/student/StudentMainActivity.java`)
- Role routing → Lecturer app shell: routes lecturer
- Student app shell → Classes and materials: opens classes
- Student app shell → Home and schedule: opens home (evidence: `app/src/main/java/com/ppquang06/uniclassapp/ui/student/home/StudentHomeFragment.java`)
- Student app shell → QR check-in: opens QR scan (evidence: `app/src/main/java/com/ppquang06/uniclassapp/ui/student/qr/StudentScanQrFragment.java`)
- Classes and materials → Uni-Class service: joins and retrieves classes (evidence: `README.md`)
- Assignments and grades → Uni-Class service: submits coursework (evidence: `README.md`)
- QR check-in → Uni-Class service: checks in (evidence: `README.md`)
- Home and schedule → Home state: loads home data (evidence: `app/src/main/java/com/ppquang06/uniclassapp/ui/student/home/StudentHomeFragment.java`)
- Home state → Repositories: requests summaries (evidence: `app/src/main/java/com/ppquang06/uniclassapp/ui/common/HomeViewModel.java`)
- Semester schedule → Home state: uses schedule state (evidence: `app/src/main/java/com/ppquang06/uniclassapp/ui/common/SemesterScheduleFragment.java`)
- Lecturer app shell → Class management: opens class tools
- Lecturer app shell → Assignment grading: opens grading
- Lecturer app shell → Live QR sessions: opens attendance
- Live QR sessions → QR display: starts QR session (evidence: `app/src/main/java/com/ppquang06/uniclassapp/ui/lecturer/attendance/LecturerQrSessionFragment.java`)
- Class management → Uni-Class service: manages classes (evidence: `README.md`)
- Assignment grading → Uni-Class service: grades submissions (evidence: `README.md`)
- QR display → Uni-Class service: opens attendance session (evidence: `README.md`)
- Live QR sessions → Realtime WebSocket: receives live updates
- Repositories → Class and user API: uses endpoints (evidence: `app/src/main/java/com/ppquang06/uniclassapp/data/repository/ClassRepository.java`)
- Class and user API → Uni-Class service: calls class endpoints (evidence: `app/src/main/java/com/ppquang06/uniclassapp/data/api/UserClassApiService.java`)
- Repositories → Room cache: caches data (evidence: `app/src/main/java/com/ppquang06/uniclassapp/data/repository/ClassRepository.java`)
- Uni-Class service → Firebase Cloud Messaging: sends push events (evidence: `README.md`)
- Firebase Cloud Messaging → Push notifications: delivers messages (evidence: `app/src/main/java/com/ppquang06/uniclassapp/service/UniClassFirebaseMessagingService.java`)
- Push notifications → Session storage: saves device token (evidence: `app/src/main/java/com/ppquang06/uniclassapp/service/UniClassFirebaseMessagingService.java`)
