# systemconsultantgroup/s-top-backend architecture

> Architecture diagram of the GitHub repository systemconsultantgroup/s-top-backend, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-23). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/systemconsultantgroup/s-top-backend
- Repository: https://github.com/systemconsultantgroup/s-top-backend

## Overview

##### Main Components

a. Core Application Layers:
- Controllers Layer (REST API endpoints)
- Service Layer (Business Logic)
- Repository Layer (Data Access)
- Domain Layer (Entity Models)

b. Cross-cutting Concerns:
- Authentication/Authorization (JWT)
- File Storage (MinIO)
- Email Service
- Global Exception Handling
- Configuration Management

##### Key Architectural Elements

a. Module Organization:
- User Management
- Authentication
- Project Management
- File Management
- Event Management
- Video Management
- Gallery
- Notice System
- Job Information
- Quiz System
- Proposal System

**External Systems/Clients**
- ↓
- API Gateway
- ↓
**Security Layer (JWT/Auth)**
- ↓
**Controller Layer**
- ↓
**Service Layer**
- ↓
**Repository Layer**
- ↓
**Database Layer**

##### Authentication Flow
- Kakao OAuth Integration
- JWT Token Management
- Refresh Token Handling

##### File Management
- MinIO Integration
- File Upload/Download Flow

##### Core Business Logic
- Project Management
- User Management
- Event Management

##### Supporting Services
- Email Service
- Excel Export
- Async Operations

Use the following visual elements:

- Blue: External Services
- Green: API Layer
- Yellow: Business Logic
- Orange: Data Access
- Gray: Infrastructure Services

Specific notations for:
- Database connections
- External service integrations (Kakao OAuth, MinIO)
- Async event handling
- Cache layers if present
- Security boundaries

Key Relationships to Highlight:
##### User management and authorization

Additional Considerations:
- Error handling flows
- Async event processing paths
- Security boundaries
- Document caching strategies if present
- Database relationships

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph External["External Systems"]
        Client["Client Applications"]
        KakaoOAuth["Kakao OAuth"]
        MinIOStorage["MinIO Storage"]
        EmailServer["Email Server"]
    end

    subgraph API["API Layer"]
        GEH["Global Exception Handler"]:::exception
        click GEH "https://github.com/SystemConsultantGroup/S-top-backend/blob/develop/src/main/java/com/scg/stop/global/exception/GlobalExceptionHandler.java"
        
        subgraph Controllers["Controllers"]
            UC["User Controller"]:::controller
            click UC "https://github.com/SystemConsultantGroup/S-top-backend/blob/develop/src/main/java/com/scg/stop/user/controller/UserController.java"
            PC["Project Controller"]:::controller
            click PC "https://github.com/SystemConsultantGroup/S-top-backend/blob/develop/src/main/java/com/scg/stop/project/controller/ProjectController.java"
            EC["Event Controller"]:::controller
            click EC "https://github.com/SystemConsultantGroup/S-top-backend/blob/develop/src/main/java/com/scg/stop/event/controller/EventNoticeController.java"
            QC["Quiz Controller"]:::controller
            click QC "https://github.com/SystemConsultantGroup/S-top-backend/blob/develop/src/main/java/com/scg/stop/video/controller/QuizController.java"
        end
    end

    subgraph Security["Security Layer"]
        JWT["JWT Util"]:::security
        click JWT "https://github.com/SystemConsultantGroup/S-top-backend/blob/develop/src/main/java/com/scg/stop/auth/JwtUtil.java"
        OAuth["OAuth Provider"]:::security
        click OAuth "https://github.com/SystemConsultantGroup/S-top-backend/blob/develop/src/main/java/com/scg/stop/auth/infrastructure/KakaoOAuthProvider.java"
    end

    subgraph Services["Service Layer"]
        US["User Service"]:::service
        click US "https://github.com/SystemConsultantGroup/S-top-backend/blob/develop/src/main/java/com/scg/stop/user/service/UserService.java"
        PS["Project Service"]:::service
        click PS "https://github.com/SystemConsultantGroup/S-top-backend/blob/develop/src/main/java/com/scg/stop/project/service/ProjectService.java"
        ES["Event Service"]:::service
        click ES "https://github.com/SystemConsultantGroup/S-top-backend/blob/develop/src/main/java/com/scg/stop/event/service/EventNoticeService.java"
        FS["File Service"]:::service
        click FS "https://github.com/SystemConsultantGroup/S-top-backend/blob/develop/src/main/java/com/scg/stop/file/service/MinioClientService.java"
        QS["Quiz Service"]:::service
        click QS "https://github.com/SystemConsultantGroup/S-top-backend/blob/develop/src/main/java/com/scg/stop/video/service/QuizService.java"
        EmailS["Email Service"]:::service
        click EmailS "https://github.com/SystemConsultantGroup/S-top-backend/blob/develop/src/main/java/com/scg/stop/global/infrastructure/EmailService.java"
    end

    subgraph Domain["Domain Layer"]
        User["User"]:::domain
        click User "https://github.com/SystemConsultantGroup/S-top-backend/blob/develop/src/main/java/com/scg/stop/user/domain/User.java"
        Project["Project"]:::domain
        click Project "https://github.com/SystemConsultantGroup/S-top-backend/blob/develop/src/main/java/com/scg/stop/project/domain/Project.java"
        Event["Event"]:::domain
        click Event "https://github.com/SystemConsultantGroup/S-top-backend/blob/develop/src/main/java/com/scg/stop/event/domain/EventNotice.java"
        Quiz["Quiz"]:::domain
        click Quiz "https://github.com/SystemConsultantGroup/S-top-backend/blob/develop/src/main/java/com/scg/stop/video/domain/Quiz.java"
    end

    subgraph Config["Configuration"]
        WC["Web Config"]:::config
        click WC "https://github.com/SystemConsultantGroup/S-top-backend/blob/develop/src/main/java/com/scg/stop/global/config/WebConfig.java"
        AC["Async Config"]:::config
        click AC "https://github.com/SystemConsultantGroup/S-top-backend/blob/develop/src/main/java/com/scg/stop/global/config/AsyncConfig.java"
        MC["MinIO Config"]:::config
        click MC "https://github.com/SystemConsultantGroup/S-top-backend/blob/develop/src/main/java/com/scg/stop/file/config/MinioConfig.java"
        EC["Email Config"]:::config
        click EC "https://github.com/SystemConsultantGroup/S-top-backend/blob/develop/src/main/java/com/scg/stop/global/config/EmailServiceConfig.java"
        JC["JPA Config"]:::config
        click JC "https://github.com/SystemConsultantGroup/S-top-backend/blob/develop/src/main/java/com/scg/stop/global/config/JpaAuditingConfig.java"
    end

    subgraph Util["Utilities"]
        ExcelUtil["Excel Utility"]:::util
        click ExcelUtil "https://github.com/SystemConsultantGroup/S-top-backend/blob/develop/src/main/java/com/scg/stop/global/excel/ExcelUtil.java"
        ExcelBase["Excel Base"]:::util
        click ExcelBase "https://github.com/SystemConsultantGroup/S-top-backend/blob/develop/src/main/java/com/scg/stop/global/excel/Excel.java"
    end

    %% Relationships
    Client --> Security
    KakaoOAuth --> OAuth
    Security --> Controllers
    Controllers --> Services
    Services --> Domain
    FS --> MinIOStorage
    EmailS --> EmailServer
    Services --> ExcelUtil
    GEH --> Controllers

    %% Styling
    classDef controller fill:#90EE90
    classDef service fill:#FFE4B5
    classDef domain fill:#ADD8E6
    classDef security fill:#FFB6C1
    classDef config fill:#DDA0DD
    classDef exception fill:#FF6B6B
    classDef util fill:#F0E68C

    %% Legend
    subgraph Legend
        L1["Controller"]:::controller
        L2["Service"]:::service
        L3["Domain"]:::domain
        L4["Security"]:::security
        L5["Config"]:::config
        L6["Exception"]:::exception
        L7["Utility"]:::util
    end
```
