# sktech0/virtualclassroom architecture

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

- Interactive diagram: https://gitdiagram.com/sktech0/virtualclassroom
- Repository: https://github.com/sktech0/virtualclassroom

## Overview

##### Project type and purpose
- This is a full-stack, real-time virtual classroom application.
- Frontend: Angular 17 single-page application (“live-study-room”).
- Backend: .NET 8.0 Web API (“VirtualClassroom.Backend”) exposing REST endpoints and a SignalR hub.
- Purpose: enable live study rooms, chat, Pomodoro timer, leaderboards, and secure authentication.

##### File structure
- Top level:
- VirtualClassroom.sln (Visual Studio solution)
- VirtualClassroom.Backend/ (API project)
- live-study-room/ (Angular client)
- Backend folders:
- Controllers (Auth, Room, Pomodoro) → HTTP entry points
- Hubs (RoomHub) → SignalR real-time channel
- Services/Interfaces → business logic layer
- Data/ApplicationDbContext + Migrations → EF Core persistence layer
- Models & DTOs → domain entities and data contracts
- Frontend folders:
- core (guards, interceptors, ApiService, SignalRService, AuthService)
- features (auth, room, chat, pomodoro, leaderboard, landing)
- shared (reusable components, pipes, models)
- app.routes.ts → route definitions

##### Key architectural insights from README
- Uses JWT for authentication.
- Implements real-time communication with SignalR.
- EF Core-backed SQL Server (LocalDB) for persistence.
- Angular HTTP + SignalR client for API calls and live updates.

a. Main components
1) Angular SPA (UI):
– Core modules: routing, guards, interceptors
– Feature modules: Auth, Room, Chat, Pomodoro, Leaderboard
– SignalR client service
2) .NET Core Web API:
– Controllers (AuthController, RoomController, PomodoroController)
– SignalR Hub (RoomHub)
– Services (AuthService, RoomService, PomodoroService, JwtTokenService)
– EF Core DataContext (ApplicationDbContext)
– Models + DTOs
3) Database: SQL Server / LocalDB
4) External: Browser clients; optional CDN or hosting environment

b. Relationships & interactions
– UI → Backend via HTTPS REST (Auth, Room, Pomodoro endpoints)
– UI ↔ Backend via WebSocket (SignalR hub for room events and chat messages)
– Backend Services ↔ EF Core DbContext → Database
– Auth flow: user logs in/registers → JwtTokenService issues JWT → Angular interceptor attaches JWT to HTTP/SignalR calls
– Real-time flow: Angular SignalRService connects to RoomHub → receive/send chat messages, join/leave room notifications

c. Architectural patterns & principles
– Layered architecture in backend (Presentation: Controllers/Hubs → Business: Services → Data: EF Core)
– Modular Angular structure (Core vs Features vs Shared)
– Separation of concerns, single responsibility for controllers vs services
– DTOs for mapping between domain models and API contracts
– Dependency injection throughout (.NET Core DI, Angular providers)
– Real-time event-driven communication via SignalR

d. Key technologies & frameworks
– Frontend: Angular 17, TypeScript, Angular Router, HTTPClient, SignalR client, RxJS
– Backend: .NET 8.0, ASP.NET Core Web API, SignalR, Entity Framework Core, JWT Bearer Authentication, SQL Server

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Frontend Swimlane
    subgraph "Frontend Layer"
        direction TB
        subgraph "Core Modules" 
            direction TB
            AuthGuard["AuthGuard"]:::frontend
            JwtInterceptor["JwtInterceptor"]:::frontend
            ApiService["ApiService"]:::frontend
            AuthService_FE["AuthService"]:::frontend
            SignalRService["SignalRService"]:::frontend
        end
        subgraph "Feature Modules"
            direction TB
            subgraph "Auth Feature"
                direction TB
                AuthRoutes["auth.routes.ts"]:::frontend
                LoginComponent["LoginComponent"]:::frontend
                RegisterComponent["RegisterComponent"]:::frontend
            end
            subgraph "Room Feature"
                direction TB
                RoomRoutes["room.routes.ts"]:::frontend
                RoomListComponent["RoomListComponent"]:::frontend
                RoomComponent["RoomComponent"]:::frontend
            end
            subgraph "Chat Feature"
                direction TB
                ChatRoutes["chat.routes.ts"]:::frontend
                ChatComponent["ChatComponent"]:::frontend
            end
            subgraph "Pomodoro Feature"
                direction TB
                PomodoroRoutes["pomodoro.routes.ts"]:::frontend
                PomodoroComponent["PomodoroComponent"]:::frontend
            end
            subgraph "Leaderboard Feature"
                direction TB
                LeaderboardRoutes["leaderboard.routes.ts"]:::frontend
                LeaderboardComponent["LeaderboardComponent"]:::frontend
            end
            subgraph "Landing Feature"
                direction TB
                LandingRoutes["landing.routes.ts"]:::frontend
                LandingComponent["LandingComponent"]:::frontend
            end
        end
        subgraph "Shared Modules"
            direction TB
            PrimaryButtonComponent["PrimaryButtonComponent"]:::frontend
            ConfirmModalComponent["ConfirmModalComponent"]:::frontend
            RoomModel["room.model.ts"]:::frontend
            UserModel["user.model.ts"]:::frontend
            UsernamePipe["username.pipe.ts"]:::frontend
        end
    end

    %% Backend Swimlane
    subgraph "Backend Layer"
        direction TB
        subgraph "Controllers"
            direction TB
            AuthController["AuthController"]:::backend
            RoomController["RoomController"]:::backend
            PomodoroController["PomodoroController"]:::backend
        end
        subgraph "SignalR Hub"
            direction TB
            RoomHub["RoomHub"]:::ws
        end
        subgraph "Services"
            direction TB
            AuthService_BE["AuthService"]:::backend
            RoomService["RoomService"]:::backend
            PomodoroService["PomodoroService"]:::backend
            JwtTokenService["JwtTokenService"]:::backend
        end
        subgraph "Data Layer"
            direction TB
            ApplicationDbContext["ApplicationDbContext"]:::db
            Database["SQL Server / LocalDB"]:::db
        end
    end

    %% Communications
    AuthRoutes -->|HTTPS/REST JSON| AuthController
    RoomRoutes -->|HTTPS/REST JSON| RoomController
    PomodoroRoutes -->|HTTPS/REST JSON| PomodoroController

    SignalRService -->|WSS/SignalR| RoomHub
    RoomHub -->|invokes| RoomService

    AuthController -->|calls| AuthService_BE
    RoomController -->|calls| RoomService
    PomodoroController -->|calls| PomodoroService
    AuthService_BE -->|uses| JwtTokenService

    AuthService_BE -->|EF Core| ApplicationDbContext
    RoomService -->|EF Core| ApplicationDbContext
    PomodoroService -->|EF Core| ApplicationDbContext
    JwtTokenService -->|issues JWT| AuthController

    ApplicationDbContext -->|persists| Database

    %% Click Events - Frontend Core
    click AuthGuard "https://github.com/sktech0/virtualclassroom/blob/master/live-study-room/src/app/core/guards/auth.guard.ts"
    click JwtInterceptor "https://github.com/sktech0/virtualclassroom/blob/master/live-study-room/src/app/core/interceptors/jwt.interceptor.ts"
    click ApiService "https://github.com/sktech0/virtualclassroom/blob/master/live-study-room/src/app/core/services/api.service.ts"
    click AuthService_FE "https://github.com/sktech0/virtualclassroom/blob/master/live-study-room/src/app/core/services/auth.service.ts"
    click SignalRService "https://github.com/sktech0/virtualclassroom/blob/master/live-study-room/src/app/core/services/signalr.service.ts"

    %% Click Events - Frontend Features
    click AuthRoutes "https://github.com/sktech0/virtualclassroom/blob/master/live-study-room/src/app/features/auth/auth.routes.ts"
    click LoginComponent "https://github.com/sktech0/virtualclassroom/blob/master/live-study-room/src/app/features/auth/login.component.ts"
    click RegisterComponent "https://github.com/sktech0/virtualclassroom/blob/master/live-study-room/src/app/features/auth/register.component.ts"

    click RoomRoutes "https://github.com/sktech0/virtualclassroom/blob/master/live-study-room/src/app/features/room/room.routes.ts"
    click RoomListComponent "https://github.com/sktech0/virtualclassroom/blob/master/live-study-room/src/app/features/room/room-list.component.ts"
    click RoomComponent "https://github.com/sktech0/virtualclassroom/blob/master/live-study-room/src/app/features/room/room.component.ts"

    click ChatRoutes "https://github.com/sktech0/virtualclassroom/blob/master/live-study-room/src/app/features/chat/chat.routes.ts"
    click ChatComponent "https://github.com/sktech0/virtualclassroom/blob/master/live-study-room/src/app/features/chat/chat.component.ts"

    click PomodoroRoutes "https://github.com/sktech0/virtualclassroom/blob/master/live-study-room/src/app/features/pomodoro/pomodoro.routes.ts"
    click PomodoroComponent "https://github.com/sktech0/virtualclassroom/blob/master/live-study-room/src/app/features/pomodoro/pomodoro.component.ts"

    click LeaderboardRoutes "https://github.com/sktech0/virtualclassroom/blob/master/live-study-room/src/app/features/leaderboard/leaderboard.routes.ts"
    click LeaderboardComponent "https://github.com/sktech0/virtualclassroom/blob/master/live-study-room/src/app/features/leaderboard/leaderboard.component.ts"

    click LandingRoutes "https://github.com/sktech0/virtualclassroom/blob/master/live-study-room/src/app/features/landing/landing.routes.ts"
    click LandingComponent "https://github.com/sktech0/virtualclassroom/blob/master/live-study-room/src/app/features/landing/landing.component.ts"

    %% Click Events - Frontend Shared
    click PrimaryButtonComponent "https://github.com/sktech0/virtualclassroom/blob/master/live-study-room/src/app/shared/button/primary-button.component.ts"
    click ConfirmModalComponent "https://github.com/sktech0/virtualclassroom/blob/master/live-study-room/src/app/shared/modal/confirm-modal.component.ts"
    click RoomModel "https://github.com/sktech0/virtualclassroom/blob/master/live-study-room/src/app/shared/models/room.model.ts"
    click UserModel "https://github.com/sktech0/virtualclassroom/blob/master/live-study-room/src/app/shared/models/user.model.ts"
    click UsernamePipe "https://github.com/sktech0/virtualclassroom/blob/master/live-study-room/src/app/shared/pipes/username.pipe.ts"

    %% Click Events - Backend
    click AuthController "https://github.com/sktech0/virtualclassroom/blob/master/VirtualClassroom.Backend/Controllers/AuthController.cs"
    click RoomController "https://github.com/sktech0/virtualclassroom/blob/master/VirtualClassroom.Backend/Controllers/RoomController.cs"
    click PomodoroController "https://github.com/sktech0/virtualclassroom/blob/master/VirtualClassroom.Backend/Controllers/PomodoroController.cs"
    click RoomHub "https://github.com/sktech0/virtualclassroom/blob/master/VirtualClassroom.Backend/Hubs/RoomHub.cs"
    click AuthService_BE "https://github.com/sktech0/virtualclassroom/blob/master/VirtualClassroom.Backend/Services/AuthService.cs"
    click RoomService "https://github.com/sktech0/virtualclassroom/blob/master/VirtualClassroom.Backend/Services/RoomService.cs"
    click PomodoroService "https://github.com/sktech0/virtualclassroom/blob/master/VirtualClassroom.Backend/Services/PomodoroService.cs"
    click JwtTokenService "https://github.com/sktech0/virtualclassroom/blob/master/VirtualClassroom.Backend/Services/JwtTokenService.cs"
    click ApplicationDbContext "https://github.com/sktech0/virtualclassroom/blob/master/VirtualClassroom.Backend/Data/ApplicationDbContext.cs"
    click Database "https://github.com/sktech0/virtualclassroom/tree/master/VirtualClassroom.Backend/Migrations"

    %% Styles
    classDef frontend fill:#cce5ff,stroke:#333,stroke-width:1px
    classDef backend fill:#d4edda,stroke:#333,stroke-width:1px
    classDef db fill:#fff3cd,stroke:#333,stroke-width:1px
    classDef ws fill:#f5c6cb,stroke:#333,stroke-width:1px
    classDef service fill:#d1ecf1,stroke:#333,stroke-width:1px
    class AuthService_BE,RoomService,PomodoroService,JwtTokenService service
    class ApplicationDbContext,Database db
```
