# codemaestro27/teachers_preferences architecture

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

- Interactive diagram: https://gitdiagram.com/codemaestro27/teachers_preferences
- Repository: https://github.com/codemaestro27/teachers_preferences

## Overview

##### Project type and purpose
- This is a full‐stack web application (“teachers_preferences”) designed to collect and manage university instructors’ scheduling and exam preferences.
- Backend: Java + Spring Boot REST API with security (JWT), database initialization, and Excel export.
- Frontend: React.js SPA built with Vite and Tailwind CSS, served via Nginx in Docker.
- Use cases: Teacher login & preference submission; Admin login, data review, deadline management, and Excel export.

##### File structure
- Top‐level:
- backend/ – Spring Boot service
- frontend/ – React SPA
- docker-compose.yml – orchestration of containers
- backend/
- pom.xml – Maven dependencies
- src/main/java/com/example…
– config (DataInitializer, SecurityConfig)
– controller (AuthController, TeacherController, AdminController)
– service (AuthService, TeacherService, AdminService)
– repository (UserRepository, TeacherRepository, PreferenceRepository)
– model/DTO (User, Teacher, Preference, Role, PreferenceDto)
– security (JwtAuthFilter)
- application.properties – DB & security settings
- tests – unit & integration tests per layer
- frontend/
- package.json, vite.config.js – build & dev setup
- src/
– components (Login, Register, PreferencesForm, Dashboards)
– api.js – REST client wrapper
– data/rooms.json – static data
– App.jsx, main.jsx – entry points
- nginx.conf – reverse proxy instructions
- Dockerfile – container setup

##### Key insights from README
- RESTful API on port 8080; React dev server on 5173.
- PostgreSQL (production) / H2 (test) backends.
- Spring Security + JWT for auth.
- Excel export via Apache POI.
- Two roles: TEACHER and ADMIN with different UI flows.

##### Elements
- Labels
- “React SPA”
- “Nginx Reverse Proxy”
- “Spring Boot API”
- “PostgreSQL DB”
- “JWTAuthFilter”, “Controllers”, “Services”, “Repositories”
- From Browser → Nginx → API → DB → back
- From API → Apache POI (export flow)
- Client: light blue / rectangle
- Server components: green / blocks grouped by layer
- External libs (POI) in different shade

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Docker Compose
    subgraph "Infrastructure"
        DockerCompose["docker-compose.yml"]:::infra
    end

    %% Client Layer
    subgraph "Client Layer"
        direction TB
        Browser["Browser"]:::client
        subgraph "React SPA" 
            direction TB
            Components["Components (Login, Register, PreferencesForm, Dashboards)"]:::client
            EntryPoints["App.jsx, main.jsx"]:::client
            StaticData["rooms.json"]:::client
        end
    end

    %% Proxy Layer
    subgraph "Proxy Layer"
        direction TB
        Nginx["Nginx Reverse Proxy (5173/8080)"]:::proxy
    end

    %% Backend Layer
    subgraph "Backend Layer"
        direction TB
        SpringApp["Spring Boot API (8080)"]:::backend
        subgraph "Security"
            direction TB
            JwtFilter["JwtAuthFilter"]:::backend
            Config["DataInitializer, SecurityConfig"]:::backend
        end
        subgraph "Controllers"
            direction TB
            AuthCtrl["AuthController"]:::backend
            TeacherCtrl["TeacherController"]:::backend
            AdminCtrl["AdminController"]:::backend
        end
        subgraph "Services"
            direction TB
            AuthSvc["AuthService"]:::backend
            TeacherSvc["TeacherService"]:::backend
            AdminSvc["AdminService"]:::backend
        end
        subgraph "Repositories"
            direction TB
            UserRepo["UserRepository"]:::backend
            TeacherRepo["TeacherRepository"]:::backend
            PrefRepo["PreferenceRepository"]:::backend
        end
        subgraph "Models & DTOs"
            direction TB
            Models["User, Teacher, Preference, Role"]:::backend
            DTOs["PreferenceDto"]:::backend
        end
        Properties["application.properties"]:::backend
    end

    %% Data & External
    subgraph "Data & External"
        direction TB
        Postgres["PostgreSQL DB"]:::db
        H2["H2 (Test DB)"]:::db
        POI["Apache POI"]:::ext
    end

    %% Connections
    DockerCompose -->|orchestrates| Browser
    DockerCompose -->|orchestrates| Nginx
    DockerCompose -->|orchestrates| SpringApp
    DockerCompose -->|orchestrates| Postgres

    Browser -->|HTTP/HTTPS| Nginx
    Nginx -->|proxy /api| SpringApp
    SpringApp -->|JDBC| Postgres
    SpringApp -->|in-memory| H2
    SpringApp -->|export| POI
    SpringApp -->|uses| JwtFilter
    SpringApp -->|calls| AuthCtrl
    SpringApp -->|calls| TeacherCtrl
    SpringApp -->|calls| AdminCtrl
    AuthCtrl -->|uses| AuthSvc
    TeacherCtrl -->|uses| TeacherSvc
    AdminCtrl -->|uses| AdminSvc
    AuthSvc -->|access| UserRepo
    TeacherSvc -->|access| TeacherRepo
    AdminSvc -->|access| PrefRepo
    AuthSvc -->|produces| DTOs
    TeacherSvc -->|produces| DTOs
    AdminSvc -->|produces| DTOs
    Repositories -->|persist| Models
    Properties -->|configures| SpringApp

    %% Click Events
    click DockerCompose "https://github.com/codemaestro27/teachers_preferences/blob/main/docker-compose.yml"
    click Browser "https://github.com/codemaestro27/teachers_preferences/tree/main/frontend/src"
    click Components "https://github.com/codemaestro27/teachers_preferences/tree/main/frontend/src/components"
    click EntryPoints "https://github.com/codemaestro27/teachers_preferences/blob/main/frontend/src/main.jsx"
    click EntryPoints "https://github.com/codemaestro27/teachers_preferences/blob/main/frontend/src/App.jsx"
    click StaticData "https://github.com/codemaestro27/teachers_preferences/blob/main/frontend/src/data/rooms.json"
    click Nginx "https://github.com/codemaestro27/teachers_preferences/blob/main/frontend/nginx.conf"
    click DockerCompose "https://github.com/codemaestro27/teachers_preferences/blob/main/docker-compose.yml"
    click SpringApp "https://github.com/codemaestro27/teachers_preferences/blob/main/backend/src/main/java/com/example/webapp/PreferencesBackendApplication.java"
    click AuthCtrl "https://github.com/codemaestro27/teachers_preferences/tree/main/backend/src/main/java/com/example/webapp/controller"
    click TeacherCtrl "https://github.com/codemaestro27/teachers_preferences/tree/main/backend/src/main/java/com/example/webapp/controller"
    click AdminCtrl "https://github.com/codemaestro27/teachers_preferences/tree/main/backend/src/main/java/com/example/webapp/controller"
    click AuthSvc "https://github.com/codemaestro27/teachers_preferences/tree/main/backend/src/main/java/com/example/webapp/service"
    click TeacherSvc "https://github.com/codemaestro27/teachers_preferences/tree/main/backend/src/main/java/com/example/webapp/service"
    click AdminSvc "https://github.com/codemaestro27/teachers_preferences/tree/main/backend/src/main/java/com/example/webapp/service"
    click UserRepo "https://github.com/codemaestro27/teachers_preferences/tree/main/backend/src/main/java/com/example/webapp/repository"
    click TeacherRepo "https://github.com/codemaestro27/teachers_preferences/tree/main/backend/src/main/java/com/example/webapp/repository"
    click PrefRepo "https://github.com/codemaestro27/teachers_preferences/tree/main/backend/src/main/java/com/example/webapp/repository"
    click JwtFilter "https://github.com/codemaestro27/teachers_preferences/blob/main/backend/src/main/java/com/example/webapp/security/JwtAuthFilter.java"
    click Config "https://github.com/codemaestro27/teachers_preferences/tree/main/backend/src/main/java/com/example/webapp/config"
    click Models "https://github.com/codemaestro27/teachers_preferences/tree/main/backend/src/main/java/com/example/webapp/model"
    click DTOs "https://github.com/codemaestro27/teachers_preferences/tree/main/backend/src/main/java/com/example/webapp/dto"
    click Properties "https://github.com/codemaestro27/teachers_preferences/blob/main/backend/src/main/resources/application.properties"
    click DockerCompose "https://github.com/codemaestro27/teachers_preferences/tree/main/backend/Dockerfile"
    click DockerCompose "https://github.com/codemaestro27/teachers_preferences/tree/main/frontend/Dockerfile"

    %% Styles
    classDef client fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef proxy fill:#90EE90,stroke:#333,stroke-width:1px
    classDef backend fill:#98FB98,stroke:#333,stroke-width:1px
    classDef db fill:#FFA500,stroke:#333,stroke-width:1px
    classDef ext fill:#D3D3D3,stroke:#333,stroke-width:1px
    classDef infra fill:#DCDCDC,stroke:#333,stroke-width:1px
```
