# jjoonior/pading architecture

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

- Interactive diagram: https://gitdiagram.com/jjoonior/pading
- Repository: https://github.com/jjoonior/pading

## Overview

##### Project type and purpose
- This is a full-stack, real-time collaborative coding platform (“Pading”) with features for pair programming: group/project management, chat, video conferencing, shared IDE (Monaco+Yjs), terminal (Xterm.js+STOMP), auto-build/deploy, resource monitoring, AI code review.
- The front-end is a React/TypeScript single-page application (Vite, Tailwind). The back-end is a Spring Boot monolith using REST and STOMP over WebSocket, backed by a relational database, Redis, and Kubernetes.

##### File structure
- front-end/: React components organized by feature (groups, projects, chat, videochat, file explorer, editor, monitoring). Uses Redux for global state and context for editor.
- back-end/: Spring Boot with layered packages (config, controller, service, repository, entity, aop, interceptor). Config includes WebSocketConfig, RedisConfig, KubernetesConfig, OAuth2Config, JWT filter.
- exec/sql/: database DDL for entities (User, Group, Project, Chat, etc.).
- Dockerfile and CI config present; Kubernetes utilities exist in code (KubernetesUtil).

##### README for additional insights
- Stack: React+TS, Tailwind, Vite; Spring Boot, Gradle, Docker, Kubernetes, Redis.
- Key real-time tech: WebSocket/STOMP (chat, terminal), Yjs for CRDT editor sync, OpenVidu for video, AI code review via external API, Kubernetes orchestration for per-project containers.

a. Main components
- Client (Browser): React SPA, Monaco Editor + Yjs client, Xterm.js terminal, STOMP/SockJS client, OpenVidu JS.
- API Gateway / Web Server (optional Nginx): serves SPA assets, routes API & WebSocket.
- Backend (Spring Boot):
- REST controllers: AuthController, GroupController, ProjectController, etc.
- WebSocket endpoints: STOMP endpoints for chat, terminal, Yjs signalling.
- Kubernetes Controller: spins up project containers via Kubernetes API.
- Redis: session or cache for JWT blacklists, ephemeral data.
- Database (MySQL/Postgres): persistent storage for users, groups, projects, chat logs.
- OpenVidu signalling: interacts with OpenVidu Server.
- Kubernetes Cluster:
- Project Pods/Containers: build & runtime containers per project.
- Nginx Ingress / Service Mesh.
- OpenVidu Server: video conferencing media server.
- External OAuth Providers: Google, Kakao.
- AI Code Review Service (external API).
b. Relationships & interactions
- User → Browser SPA → REST API (JWT/OAuth2) → Backend → Database/Redis.
- Browser ↔ WebSocket (STOMP/SockJS) ↔ Spring Boot WebSocketConfig → ChatService/TerminalService/Yjs SignalServer.
- Spring Boot → Kubernetes API → create/delete project containers → container IPs.
- Browser terminal & editor connect directly (via STOMP) to their project container endpoints or WebSocket proxy.
- Browser ↔ OpenVidu Server (session join, media streams).
- Backend → AI service (HTTP) for code review.
c. Architectural patterns & principles
- Layered MVC (Spring Boot layers: controller → service → repository).
- Event-driven & message-oriented for real-time features (STOMP topics).
- CRDT synchronization pattern via Yjs.
- Micro-VM/container per project for isolation.
- OAuth2 + JWT for stateless, scalable auth.
- Kubernetes for orchestration, auto scaling.
d. Key technologies/frameworks
- Frontend: React, TypeScript, Vite, Tailwind, Redux, Monaco Editor, Yjs, Xterm.js, STOMP.js, SockJS.
- Backend: Spring Boot, Spring Security (OAuth2, JWT), Spring WebSocket, Redis, JPA/Hibernate.
- Orchestration: Docker, Kubernetes API.
- Media: OpenVidu.
- Database: MySQL/Postgres (JPA).
- Cache: Redis.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% User Browser and SPA
    subgraph "User Browser" 
        direction TB
        BrowserSPA["Client Browser SPA"]:::frontend
        subgraph "Browser SPA" 
            direction TB
            Router["React SPA Routing"]:::frontend
            Store["Global State (Redux)"]:::frontend
            VideoSlice["Video Conference State Slice"]:::frontend
            EditorContext["Project Editor Context"]:::frontend
            ProjectEditor["Monaco Editor + Yjs Client"]:::frontend
            ProjectTerminal["Xterm.js Terminal"]:::frontend
            FileExplorerWS["WebSocket (STOMP/SockJS) for File Explorer"]:::frontend
            ChatSocket["Real-time Chat & Signalling"]:::frontend
            VideoClient["OpenVidu Video Conferencing Client"]:::frontend
            AuthAPI["REST API Calls (Auth)"]:::frontend
            GroupAPI["REST API Calls (Group)"]:::frontend
            ProjectAPI["REST API Calls (Project)"]:::frontend
        end
    end

    %% API Gateway / Ingress
    Nginx["Nginx Ingress / API Gateway"]:::gateway

    %% Backend Service
    subgraph "Spring Boot Backend" 
        direction TB
        Entry["Application Entry Point"]:::backend
        subgraph "Configurations" 
            WebSocketConfig["WebSocket Configuration"]:::backend
            RedisConfig["Redis Configuration"]:::backend
            K8sConfig["Kubernetes Configuration"]:::backend
            SecurityConfig["OAuth2 & JWT Security Config"]:::backend
        end
        subgraph "Controllers" 
            direction TB
            RESTCtrl["REST Controllers"]:::backend
            WSCtrl["WebSocket/STOMP Controllers"]:::backend
        end
        subgraph "Services" 
            AuthService["AuthService"]:::backend
            GroupService["GroupService"]:::backend
            ProjectService["ProjectService"]:::backend
            ChatService["ChatService"]:::backend
            TerminalService["TerminalService"]:::backend
            OpenviduService["OpenviduService"]:::backend
        end
        subgraph "Repositories & Entities"
            Repos["JPA Repositories"]:::backend
            Entities["JPA Entities"]:::backend
        end
        K8sUtil["Kubernetes Util & NginxConfigUtil"]:::backend
    end

    %% Data Stores
    subgraph "Data Stores"
        direction TB
        Database["PostgreSQL / MySQL"]:::datastore
        Redis["Redis Cache"]:::datastore
    end

    %% Kubernetes Cluster
    subgraph "Kubernetes Cluster"
        direction TB
        K8sAPI["Kubernetes API"]:::k8s
        ProjectPods["Project Containers (Build & Runtime)"]:::k8s
    end

    %% External Services
    subgraph "External Services"
        direction TB
        OAuth["OAuth2 Providers (Google, Kakao)"]:::external
        OpenViduServer["OpenVidu Server"]:::external
        AIService["AI Code Review API"]:::external
    end

    %% Connections
    BrowserSPA -->|HTTPS| Nginx
    Router -->|calls REST| AuthAPI & GroupAPI & ProjectAPI
    AuthAPI -->|HTTPS| Nginx
    GroupAPI -->|HTTPS| Nginx
    ProjectAPI -->|HTTPS| Nginx

    Nginx -->|forwards REST| RESTCtrl
    Nginx -->|forwards WSS| WSCtrl

    BrowserSPA -->|WSS/STOMP| WSCtrl
    FileExplorerWS -->|WSS/STOMP| WSCtrl
    ChatSocket -->|WSS/STOMP| WSCtrl
    ProjectTerminal -->|WSS/STOMP| WSCtrl
    ProjectEditor -->|WSS/STOMP| WSCtrl

    RESTCtrl -->|uses| AuthService & GroupService & ProjectService
    WSCtrl -->|uses| ChatService & TerminalService & OpenviduService
    AuthService & GroupService & ProjectService & ChatService & TerminalService & OpenviduService --> Repos
    Repos --> Entities
    AuthService & GroupService & ProjectService --> Database
    ChatService --> Database
    TerminalService --> Redis
    AuthService --> Redis

    AuthService -->|calls| OAuth
    OpenviduService -->|HTTP| OpenViduServer
    ProjectService -->|HTTP| AIService

    K8sUtil -->|calls| K8sAPI
    RESTCtrl -->|calls| K8sUtil
    ProjectService -->|calls| K8sUtil
    K8sAPI --> ProjectPods

    BrowserSPA -->|media streams| OpenViduServer

    %% Click Events
    click BrowserSPA "https://github.com/jjoonior/pading/blob/develop/front-end/src/app/App.tsx"
    click Router "https://github.com/jjoonior/pading/blob/develop/front-end/src/app/router/root.tsx"
    click Store "https://github.com/jjoonior/pading/blob/develop/front-end/src/app/redux/store.ts"
    click VideoSlice "https://github.com/jjoonior/pading/blob/develop/front-end/src/app/redux/videoConferenceSlice.ts"
    click EditorContext "https://github.com/jjoonior/pading/blob/develop/front-end/src/context/ProjectEditorContext.tsx"
    click ProjectEditor "https://github.com/jjoonior/pading/blob/develop/front-end/src/features/projects/editorterminal/components/ProjectEditor.tsx"
    click ProjectTerminal "https://github.com/jjoonior/pading/blob/develop/front-end/src/features/projects/editorterminal/components/ProjectTerminal.tsx"
    click FileExplorerWS "https://github.com/jjoonior/pading/blob/develop/front-end/src/features/projects/fileexplorer/model/WebSocketComponent.tsx"
    click ChatSocket "https://github.com/jjoonior/pading/blob/develop/front-end/src/features/projects/projectpage/components/CallSocket.tsx"
    click VideoClient "https://github.com/jjoonior/pading/blob/develop/front-end/src/features/projects/videochat/index.tsx"
    click AuthAPI "https://github.com/jjoonior/pading/blob/develop/front-end/src/shared/apis/useAuthAxios.ts"
    click GroupAPI "https://github.com/jjoonior/pading/blob/develop/front-end/src/shared/apis/useGroupAxios.ts"
    click ProjectAPI "https://github.com/jjoonior/pading/blob/develop/front-end/src/shared/apis/useProjectAxios.ts"
    click Entry "https://github.com/jjoonior/pading/blob/develop/back-end/src/main/java/site/paircoding/paircoding/PairCodingApplication.java"
    click WebSocketConfig "https://github.com/jjoonior/pading/blob/develop/back-end/src/main/java/site/paircoding/paircoding/config/WebSocketConfig.java"
    click RedisConfig "https://github.com/jjoonior/pading/blob/develop/back-end/src/main/java/site/paircoding/paircoding/config/RedisConfig.java"
    click K8sConfig "https://github.com/jjoonior/pading/blob/develop/back-end/src/main/java/site/paircoding/paircoding/config/KubernetesConfig.java"
    click K8sUtil "https://github.com/jjoonior/pading/blob/develop/back-end/src/main/java/site/paircoding/paircoding/util/KubernetesUtil.java"
    click SecurityConfig "https://github.com/jjoonior/pading/blob/develop/back-end/src/main/java/site/paircoding/paircoding/config/WebSecurityConfig.java"
    click RESTCtrl "https://github.com/jjoonior/pading/tree/develop/back-end/src/main/java/site/paircoding/paircoding/controller"
    click WSCtrl "https://github.com/jjoonior/pading/blob/develop/back-end/src/main/java/site/paircoding/paircoding/controller/StompController.java"
    click AuthService "https://github.com/jjoonior/pading/blob/develop/back-end/src/main/java/site/paircoding/paircoding/service/AuthService.java"
    click GroupService "https://github.com/jjoonior/pading/blob/develop/back-end/src/main/java/site/paircoding/paircoding/service/GroupService.java"
    click ProjectService "https://github.com/jjoonior/pading/blob/develop/back-end/src/main/java/site/paircoding/paircoding/service/ProjectService.java"
    click ChatService "https://github.com/jjoonior/pading/blob/develop/back-end/src/main/java/site/paircoding/paircoding/service/ChatService.java"
    click TerminalService "https://github.com/jjoonior/pading/blob/develop/back-end/src/main/java/site/paircoding/paircoding/service/TerminalService.java"
    click OpenviduService "https://github.com/jjoonior/pading/blob/develop/back-end/src/main/java/site/paircoding/paircoding/service/OpenviduService.java"
    click Repos "https://github.com/jjoonior/pading/tree/develop/back-end/src/main/java/site/paircoding/paircoding/repository"
    click Entities "https://github.com/jjoonior/pading/tree/develop/back-end/src/main/java/site/paircoding/paircoding/entity"
    click Database "https://github.com/jjoonior/pading/blob/develop/exec/sql/DDL.sql"
    click K8sAPI "https://github.com/jjoonior/pading/blob/develop/back-end/src/main/java/site/paircoding/paircoding/config/KubernetesConfig.java"
    click ProjectPods "https://github.com/jjoonior/pading/tree/develop/back-end/Dockerfile"

    %% Styles
    classDef frontend fill:#E0F7FA,stroke:#006064,color:#006064
    classDef gateway fill:#CFD8DC,stroke:#455A64,color:#455A64
    classDef backend fill:#E8F5E9,stroke:#1B5E20,color:#1B5E20
    classDef datastore fill:#FFF3E0,stroke:#EF6C00,color:#E65100
    classDef k8s fill:#E3F2FD,stroke:#0D47A1,color:#0D47A1
    classDef external fill:#ECEFF1,stroke:#37474F,color:#37474F
```
