# envedupnu/envedu_server architecture

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

- Interactive diagram: https://gitdiagram.com/envedupnu/envedu_server
- Repository: https://github.com/envedupnu/envedu_server

## Overview

##### Project Type and Purpose
- This is a Java Spring Boot monolithic backend for a “Smart Environmental Education” platform.
- It ingests real-time sensor data from Arduino-based devices, persists it, and provides REST/WebSocket APIs for students, educators, and admins to monitor and manage devices and data.

##### High-Level Architecture Components
a. NGINX (Reverse Proxy & SSL)
b. Spring Boot Application (single WAR/JAR)
- Controller Layer (REST + WebSocket)
- Service Layer (business logic)
- Repository Layer (Spring Data JPA)
- Cross-cutting concerns: Security (JWT + Filters), Cookie utils, Exception handling
c. Relational Database (ERD in README)
d. Redis (authentication codes, planned message queue)
e. AWS S3 (object storage for file uploads)
f. External Open APIs (air/ocean quality)
g. Slack (log notifications/alerts)

##### Internal Modules (Spring Boot)
- Authentication & Authorization
- JWT filters, CorsConfig, SecurityConfig, PrincipalDetailsService
- Redis for storing verification codes
- User Management
- Student, Educator, InviteCode, relationships via Student_Educator
- Controllers: UserAuthorizeController, UserRegisterController, UserLogoutController
- Admin Management
- AdminController, AdminService, AdminCipher
- Device Management
- UserDeviceController, UserDeviceService, DeviceUpdateDTO, repository
- Data Ingestion & Persistence
- DataUploadController & Service → writes “Seed” entries
- SeedController & WebSocket/MessageController for real-time pushes
- Data Control Subsystems (each with Controller, Service, Repository, Entities)
- DataChunk (data compilation, educating classes, units)
- DataChart (custom charts, chart types, properties)
- DataClassroom (classroom, chapters, answers)
- DataFolder (hierarchical data folders)
- DataLiteracy (custom data sets, Redis-backed entities)
- Survey
- SurveyController, SurveyService, entities for questions & answers
- OpenAPI Integration
- OpenApiController, OpenApiService, repository with custom impl for air/ocean quality
- AWS & Multipart
- AwsService, S3Config, MultipartConfig
- Mail Service (MailService)
- Redis Service (RedisConfig, RedisService)

##### Relationships & Data Flows
- Client → NGINX → Spring Boot REST/API endpoints
- WebSocket traffic (seed socket) connects via NGINX to Spring Boot’s WebSocketConfig
- Spring Boot ↔ RDB (Hibernate/JPA) for persistent entities (Users, Devices, Seed, etc.)
- Spring Boot ↔ Redis for ephemeral data (auth codes, planning queue)
- Spring Boot → AWS S3 for file/object storage
- Spring Boot → External Open APIs → internal DTOs/entities → DB
- Spring Boot → Slack via webhook/service for log/alert messages

##### Architectural Patterns & Principles
- Layered architecture (Controller → Service → Repository)
- DTO conversion layer between Controllers and Services
- Spring MVC + WebSocket for real-time and REST interfaces
- JWT-based stateless authentication with filters
- Centralized configuration (application.yml, Spring @Configuration)
- Separation of concerns via clearly named packages
- Use of Spring Data JPA repositories and custom Query/Impl where needed

##### Essential Elements
- Clear component names (e.g., “DataFolderService”, “RedisService”)
- Notes for planned features (e.g., “Redis as MQ – future”)

## Diagram (Mermaid)

```mermaid
flowchart TD
    Clients["Clients\n(Web/Mobile/Bluetooth)"]:::external -->|"HTTP/WS"| NGINX["NGINX\n(SSL, Reverse Proxy)"]:::infra
    NGINX -->|"Proxy REST/WS"| SB["Spring Boot Application"]:::app

    subgraph "Spring Boot Monolith" 
        direction TB
        SBEntry["DemoApplication"]:::app
        subgraph "Authentication & Authorization" 
            direction TB
            AuthFilter["AuthenticationFilter"]:::security
            AzFilter["AuthorizationFilter"]:::security
            SecurityCfg["SecurityConfig"]:::security
            CorsCfg["CorsConfig"]:::security
            JwtUtil["JwtUtil"]:::security
            PrincipalDetails["PrincipalDetailsService"]:::security
        end
        subgraph "User Management" 
            direction TB
            UAController["UserAuthorizeController"]:::domain
            URController["UserRegisterController"]:::domain
            ULController["UserLogoutController"]:::domain
            UserService["UserService"]:::domain
            UserRepo["UserRepository"]:::domain
        end
        subgraph "Admin Management" 
            direction TB
            AdminCtrl["AdminController"]:::domain
            AdminSvc["AdminService"]:::domain
            AdminRepo["AdminRepository"]:::domain
            AdminCipher["AdminCipher"]:::domain
        end
        subgraph "Device Management" 
            direction TB
            DevCtrl["UserDeviceController"]:::domain
            DevSvc["UserDeviceService"]:::domain
            DevRepo["UserDeviceRepository"]:::domain
            DevDTO["DeviceUpdateDTO"]:::domain
        end
        subgraph "Data Ingestion & Persistence" 
            direction TB
            UploadCtrl["DataUploadController"]:::domain
            UploadSvc["DataUploadService"]:::domain
            SeedCtrl["SeedController"]:::domain
            SeedSvc["SeedService"]:::domain
            SeedRepo["SeedRepository"]:::domain
            WSConfig["WebSocketConfig"]:::domain
            MsgCtrl["MessageController"]:::domain
        end
        subgraph "Data Control Subsystems"
            direction TB
            subgraph "DataChunk"
                DCtrl["DataChunkController"]:::domain
                DSvc["DataChunkService"]:::domain
                DRepo["DataChunkRepository"]:::domain
            end
            subgraph "DataChart"
                ChartCtrl["CustomDataChartController"]:::domain
                ChartSvc["CustomDataChartService"]:::domain
                ChartRepo["CustomDataChartRepository"]:::domain
            end
            subgraph "DataClassroom"
                ClassCtrl["ClassroomController"]:::domain
                AnsCtrl["ClassroomAnswerController"]:::domain
                ClassSvc["ClassroomService"]:::domain
                AnsSvc["ClassroomAnswerService"]:::domain
                ClassRepo["DataClassroomRepository"]:::domain
            end
            subgraph "DataFolder"
                FolderCtrl["DataFolderController"]:::domain
                FolderSvc["DataFolderService"]:::domain
                FolderRepo["DataFolderRepository"]:::domain
            end
            subgraph "DataLiteracy"
                LitCtrl["DataLiteracy Controllers"]:::domain
                LitSvc["DataLiteracy Services"]:::domain
                LitRepo["DataLiteracy Repos"]:::domain
            end
        end
        subgraph "Survey Module"
            direction TB
            SurveyCtrl["SurveyController"]:::domain
            SurveySvc["SurveyService"]:::domain
            SurveyRepo["SurveyRepository"]:::domain
        end
        subgraph "OpenAPI Integration"
            direction TB
            APICtrl["OpenApiController"]:::external
            APISvc["OpenApiService"]:::external
            APIRepo["OpenApiRepository"]:::external
            APIImpl["OpenApiRepositoryImpl"]:::external
        end
        subgraph "AWS & File Upload"
            direction TB
            AwsSvc["AwsService"]:::infra
            S3Cfg["S3Config"]:::infra
            MultipartCfg["MultipartConfig"]:::infra
        end
        subgraph "Mail & Redis Services"
            direction TB
            MailSvc["MailService"]:::infra
            MailEx["CustomMailException"]:::infra
            RedisCfg["RedisConfig"]:::infra
            RedisSvc["RedisService"]:::infra
            AuthNumRepo["AuthNumRepository"]:::infra
        end
    end

    SB -->|"JPA/Hibernate"| RDB[(Relational DB)]:::infra
    SB -->|"Cache/Auth Codes"| Redis[(Redis)]:::infra
    SB -->|"File Storage"| S3[(AWS S3)]:::infra
    SB -->|"HTTP calls"| ExtAPI[(Air/Ocean Quality APIs)]:::external
    SB -->|"Webhook"| Slack[(Slack)]:::external

    %% Click Events
    click SBEntry "https://github.com/envedupnu/envedu_server/blob/main/src/main/java/com/example/demo/DemoApplication.java"
    click SecurityCfg "https://github.com/envedupnu/envedu_server/blob/main/src/main/java/com/example/demo/security/config/SecurityConfig.java"
    click CorsCfg "https://github.com/envedupnu/envedu_server/blob/main/src/main/java/com/example/demo/security/config/CorsConfig.java"
    click JwtUtil "https://github.com/envedupnu/envedu_server/blob/main/src/main/java/com/example/demo/jwt/util/JwtUtil.java"
    click AuthFilter "https://github.com/envedupnu/envedu_server/blob/main/src/main/java/com/example/demo/security/config/AuthenticationFilter.java"
    click AzFilter "https://github.com/envedupnu/envedu_server/blob/main/src/main/java/com/example/demo/security/config/AuthorizationFilter.java"
    click PrincipalDetails "https://github.com/envedupnu/envedu_server/blob/main/src/main/java/com/example/demo/security/principal/PrincipalDetailsService.java"
    click UAController "https://github.com/envedupnu/envedu_server/blob/main/src/main/java/com/example/demo/user/controller/UserAuthorizeController.java"
    click URController "https://github.com/envedupnu/envedu_server/blob/main/src/main/java/com/example/demo/user/controller/UserRegisterController.java"
    click ULController "https://github.com/envedupnu/envedu_server/blob/main/src/main/java/com/example/demo/user/controller/UserLogoutController.java"
    click UserService "https://github.com/envedupnu/envedu_server/blob/main/src/main/java/com/example/demo/user/service/UserService.java"
    click UserRepo "https://github.com/envedupnu/envedu_server/blob/main/src/main/java/com/example/demo/user/repository/UserRepository.java"
    click AdminCtrl "https://github.com/envedupnu/envedu_server/blob/main/src/main/java/com/example/demo/admin/controller/AdminController.java"
    click AdminSvc "https://github.com/envedupnu/envedu_server/blob/main/src/main/java/com/example/demo/admin/service/AdminService.java"
    click AdminRepo "https://github.com/envedupnu/envedu_server/blob/main/src/main/java/com/example/demo/admin/repository/AdminRepository.java"
    click AdminCipher "https://github.com/envedupnu/envedu_server/blob/main/src/main/java/com/example/demo/admin/cipher/AdminCipher.java"
    click DevCtrl "https://github.com/envedupnu/envedu_server/blob/main/src/main/java/com/example/demo/device/controller/UserDeviceController.java"
    click DevSvc "https://github.com/envedupnu/envedu_server/blob/main/src/main/java/com/example/demo/device/service/UserDeviceService.java"
    click DevRepo "https://github.com/envedupnu/envedu_server/blob/main/src/main/java/com/example/demo/device/repository/UserDeviceRepository.java"
    click DevDTO "https://github.com/envedupnu/envedu_server/blob/main/src/main/java/com/example/demo/device/dto/request/DeviceUpdateDTO.java"
    click UploadCtrl "https://github.com/envedupnu/envedu_server/blob/main/src/main/java/com/example/demo/datacontrol/dataupload/DataUploadController.java"
    click UploadSvc "https://github.com/envedupnu/envedu_server/blob/main/src/main/java/com/example/demo/datacontrol/dataupload/DataUploadService.java"
    click SeedCtrl "https://github.com/envedupnu/envedu_server/blob/main/src/main/java/com/example/demo/seed/controller/SeedController.java"
    click SeedSvc "https://github.com/envedupnu/envedu_server/blob/main/src/main/java/com/example/demo/seed/service/SeedService.java"
    click SeedRepo "https://github.com/envedupnu/envedu_server/blob/main/src/main/java/com/example/demo/seed/repository/SeedRepository.java"
    click WSConfig "https://github.com/envedupnu/envedu_server/blob/main/src/main/java/com/example/demo/seed/socket/config/WebSocketConfig.java"
    click MsgCtrl "https://github.com/envedupnu/envedu_server/blob/main/src/main/java/com/example/demo/seed/socket/controller/MessageController.java"

    classDef external fill:#FFA500,stroke:#333,stroke-width:1px
    classDef infra fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef app fill:#D3D3D3,stroke:#333,stroke-width:1px
    classDef security fill:#FFCCCB,stroke:#333,stroke-width:1px
    classDef domain fill:#90EE90,stroke:#333,stroke-width:1px
```
