# wongi-kim/playus-backend architecture

> Architecture diagram of the GitHub repository wongi-kim/playus-backend, 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/wongi-kim/playus-backend
- Repository: https://github.com/wongi-kim/playus-backend

## Overview

##### Project type and purpose
- This is a monolithic, feature-driven, full-stack application:
- Backend: Java + Spring Boot REST API (this file tree)
- Frontend: Next.js + TypeScript + Tailwind CSS (deployed on Vercel)
- Database: MongoDB
- External services: Google Sheets API, JWT auth, GCP + Docker on Ubuntu
- Purpose: expose REST endpoints for admin management, user login/signup, experience tracking, quests, boards, notifications, and fetch Google Sheet data.

##### File structure
- src/main/java/org/example/playus/domain: each subpackage is a bounded context (admin, board, employee, quest, login/logout, security, sheet, signup, user, etc.).
- In each context:
- Controller classes accept HTTP requests.
- Service classes hold business logic.
- Repository interfaces access MongoDB (via Spring Data).
- DTO packages define request/response payloads.
- model or entity classes represent domain objects.
- global: common utilities (error handling, timestamped base class, configs for Mongo & Swagger).
- SecurityConfig + JWT filters chain incoming requests.
- Dockerfile + Gradle build scripts for containerized deployment.

##### README for additional insights
- ERD (data model relationships) is present.
- Environmental variables for MongoDB, MySQL (unused?), JWT, Google Sheet ID.
- Swagger for API docs.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Frontend Layer
    subgraph "Frontend Layer"
        direction TB
        NextJS["Next.js SPA"]:::frontend
    end

    %% Load Balancer / API Gateway
    LB["GCP Load Balancer"]:::backend

    %% Spring Boot Container
    subgraph "Spring Boot Container"
        direction TB
        entry["PlayusApplication"]:::backend

        Config["Global Config<br/>(MongoConfig, SwaggerConfig)"]:::backend
        entry --> Config

        Web["Spring Web MVC<br/>(Controllers)"]:::backend
        entry --> Web

        SecConfig["SecurityConfig"]:::backend
        Web --> SecConfig
        JwtAuth["JwtAuthenticationFilter"]:::backend
        JwtAuthz["JwtAuthorizationFilter"]:::backend
        SecConfig --> JwtAuth
        SecConfig --> JwtAuthz

        subgraph "Controllers"
            direction TB
            BC["BoardController"]:::backend
            EC["EmployeeController"]:::backend
            LC["LoginController"]:::backend
            LOC["LogoutController"]:::backend
            SC["SignupController"]:::backend
            UC["UserController"]:::backend
            GSC["GoogleSheetController"]:::backend
        end
        Web --> Controllers

        subgraph "Services"
            direction TB
            BS["BoardService"]:::backend
            ES["EmployeeService"]:::backend
            LS["LoginService"]:::backend
            LOS["LogoutService"]:::backend
            SS["SignupService"]:::backend
            US["UserService"]:::backend
            GSS["GoogleSheetService"]:::backend
        end
        Controllers -->|"invoke"| Services

        subgraph "Repositories"
            direction TB
            BR["BoardRepositoryMongo"]:::backend
            ER["EmployeeRepositoryMongo"]:::backend
            EER["EmployeeExpRepository"]:::backend
            GR["GroupQuestRepositoryMongo"]:::backend
            LR["LeaderQuestExpRepository"]:::backend
        end
        Services -->|"operate"| Repositories

        Helper["GoogleSheetsHelper"]:::external
        Convert["GoogleSheetsConvert"]:::external
        Services -->|"call"| Helper
        Helper --> Convert
    end

    %% Database and External
    DB[(MongoDB Atlas)]:::database
    ExtAPI["Google Sheets API"]:::external
    Repositories -->|"CRUD operations"| DB
    Helper -->|"API calls"| ExtAPI

    %% Swagger UI
    SwaggerUI["Swagger UI"]:::backend

    %% Connections
    NextJS -->|"HTTPS REST calls"| LB
    LB -->|"/api/*"| entry
    NextJS -->|"/swagger-ui"| SwaggerUI

    %% Click Events
    click entry "https://github.com/wongi-kim/playus-backend/blob/dev/src/main/java/org/example/playus/PlayusApplication.java"
    click BC "https://github.com/wongi-kim/playus-backend/blob/dev/src/main/java/org/example/playus/domain/board/BoardController.java"
    click EC "https://github.com/wongi-kim/playus-backend/blob/dev/src/main/java/org/example/playus/domain/employee/EmployeeController.java"
    click LC "https://github.com/wongi-kim/playus-backend/blob/dev/src/main/java/org/example/playus/domain/login/LoginController.java"
    click LOC "https://github.com/wongi-kim/playus-backend/blob/dev/src/main/java/org/example/playus/domain/logout/LogoutController.java"
    click SC "https://github.com/wongi-kim/playus-backend/blob/dev/src/main/java/org/example/playus/domain/signup/SignupController.java"
    click UC "https://github.com/wongi-kim/playus-backend/blob/dev/src/main/java/org/example/playus/domain/user/UserController.java"
    click GSC "https://github.com/wongi-kim/playus-backend/blob/dev/src/main/java/org/example/playus/domain/sheet/GoogleSheetController.java"
    click BS "https://github.com/wongi-kim/playus-backend/blob/dev/src/main/java/org/example/playus/domain/board/BoardService.java"
    click ES "https://github.com/wongi-kim/playus-backend/blob/dev/src/main/java/org/example/playus/domain/employee/EmployeeService.java"
    click LS "https://github.com/wongi-kim/playus-backend/blob/dev/src/main/java/org/example/playus/domain/login/LoginService.java"
    click LOS "https://github.com/wongi-kim/playus-backend/blob/dev/src/main/java/org/example/playus/domain/logout/LogoutService.java"
    click SS "https://github.com/wongi-kim/playus-backend/blob/dev/src/main/java/org/example/playus/domain/signup/SignupService.java"
    click US "https://github.com/wongi-kim/playus-backend/blob/dev/src/main/java/org/example/playus/domain/user/UserService.java"
    click GSS "https://github.com/wongi-kim/playus-backend/blob/dev/src/main/java/org/example/playus/domain/sheet/GoogleSheetService.java"
    click BR "https://github.com/wongi-kim/playus-backend/blob/dev/src/main/java/org/example/playus/domain/board/BoardRepositoryMongo.java"
    click ER "https://github.com/wongi-kim/playus-backend/blob/dev/src/main/java/org/example/playus/domain/employee/EmployeeRepositoryMongo.java"
    click EER "https://github.com/wongi-kim/playus-backend/blob/dev/src/main/java/org/example/playus/domain/employeeExp/EmployeeExpRepository.java"
    click GR "https://github.com/wongi-kim/playus-backend/blob/dev/src/main/java/org/example/playus/domain/quest/groupGuset/GroupQuestRepositoryMongo.java"
    click LR "https://github.com/wongi-kim/playus-backend/blob/dev/src/main/java/org/example/playus/domain/quest/leaderQuest/LeaderQuestExpRepository.java"
    click SecConfig "https://github.com/wongi-kim/playus-backend/blob/dev/src/main/java/org/example/playus/domain/security/config/SecurityConfig.java"
    click JwtAuth "https://github.com/wongi-kim/playus-backend/blob/dev/src/main/java/org/example/playus/domain/security/filter/JwtAuthenticationFilter.java"
    click JwtAuthz "https://github.com/wongi-kim/playus-backend/blob/dev/src/main/java/org/example/playus/domain/security/filter/JwtAuthorizationFilter.java"
    click Helper "https://github.com/wongi-kim/playus-backend/blob/dev/src/main/java/org/example/playus/domain/sheet/GoogleSheetsHelper.java"
    click Convert "https://github.com/wongi-kim/playus-backend/blob/dev/src/main/java/org/example/playus/domain/sheet/GoogleSheetsConvert.java"
    click Config "https://github.com/wongi-kim/playus-backend/blob/dev/src/main/java/org/example/playus/global/config/MongoConfig.java"
    click Config "https://github.com/wongi-kim/playus-backend/blob/dev/src/main/java/org/example/playus/global/config/SwaggerConfig.java"

    %% Styles
    classDef frontend fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef backend fill:#90EE90,stroke:#333,stroke-width:1px
    classDef database fill:#FFA500,stroke:#333,stroke-width:1px
    classDef external fill:#DDA0DD,stroke:#333,stroke-width:1px
```
