# kimjongha99/knowledge-sharing architecture

> Architecture diagram of the GitHub repository kimjongha99/knowledge-sharing, 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/kimjongha99/knowledge-sharing
- Repository: https://github.com/kimjongha99/knowledge-sharing

## Overview

##### Project type and purpose
- This is a full-stack “Knowledge-Sharing” web application.
- Front-end: React + TypeScript SPA providing article feeds, quizzes, user profiles.
- Back-end: Spring Boot monolith exposing RESTful endpoints for articles, quizzes, authentication, admin.
- Purpose: Let users post articles, take quizzes, follow others, with OAuth2 (Kakao), JWT security, and persistence in MySQL/Redis/S3.

##### File structure
- Top-level docker-compose.yml to spin up MySQL and Redis locally.
- “front-end” directory: React code (src/components, src/views, axios API client, Tailwind+CSS)
- “knowledge-sharing” directory: Spring Boot project with layered packages: controller, dto, service/impl, repository under modules: auth, article, quiz, comment, follow, hashtag, cardSet, user, admin.
- common/config for security (JWT, OAuth2), database (JPA, QueryDSL), Swagger, S3, Redis configs.
- src/main/resources/application.yml for environment settings.
- .github/workflows/GradleCI.yml runs CI on push.

##### README for additional insights
- Lists tech stack: Java, Spring Boot, Spring JPA, MySQL (Amazon RDS), Redis, Amazon S3, React TS, Axios, Docker-Compose, GitHub Actions.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Frontend Layer
    subgraph "Frontend Layer"
        direction TB
        Browser["User Browser (React SPA)"]:::frontend
        ReactApp["App.tsx"]:::frontend
        ReactIndex["index.tsx"]:::frontend
        AxiosClient["Axios API Client"]:::frontend
        TailwindConfig["tailwind.config.js"]:::frontend
        PublicIndex["public/index.html"]:::frontend
        PublicManifest["public/manifest.json"]:::frontend
    end

    %% Backend Layer
    subgraph "Backend Layer"
        direction TB
        APIEntry["KnowledgeSharingApplication.java"]:::backend
        subgraph Controllers
            direction TB
            ArticleController["ArticleController"]:::backend
            AuthController["AuthController"]:::backend
            QuizController["QuizController"]:::backend
            FollowController["FollowController"]:::backend
            CommentController["CommentController"]:::backend
            HashTagController["HashTagController"]:::backend
            CardSetController["CardSetController"]:::backend
            UserController["UserController"]:::backend
            AdminController["AdminController"]:::backend
            FileController["FileController (S3)"]:::backend
        end
        subgraph Services
            direction TB
            ServiceLayer["...Service & Impl"]:::backend
            FileService["FileService & Impl"]:::backend
            RedisService["RedisService & Impl"]:::backend
        end
        subgraph Repositories
            direction TB
            Repos["...Repository Interfaces"]:::backend
        end
        subgraph Security & Config
            direction TB
            WebSecurityConfig["WebSecurityConfig"]:::backend
            JwtFilter["JwtAuthenticationFilter & JwtProvider"]:::backend
            OAuth2Handler["OAuth2SuccessHandler & CustomOAuth2User"]:::backend
            S3Config["S3Config"]:::backend
            SwaggerConfig["SwaggerConfig"]:::backend
            QueryDslConfig["QueryDslConfig"]:::backend
            JasyptConfig["JasyptConfig"]:::backend
            RedisConfig["RedisConfig"]:::backend
        end
        APIEntry --> Controllers
        Controllers --> Services
        Services --> Repositories
        Services --> S3Config
        Services --> RedisConfig
    end

    %% Persistence Layer
    subgraph "Persistence & Cache"
        direction TB
        MySQL["MySQL RDS"]:::persistence
        Redis["Redis Cache"]:::persistence
    end

    %% External Services
    subgraph "External Services"
        direction TB
        S3["Amazon S3"]:::external
        Kakao["Kakao OAuth2"]:::external
    end

    %% CI/CD
    subgraph "CI/CD Pipeline"
        direction TB
        DockerCompose["docker-compose.yml"]:::cicd
        GitHubActions["GradleCI.yml"]:::cicd
    end

    %% Flow
    Browser -->|"loads SPA"| ReactApp
    ReactApp --> ReactIndex
    ReactApp --> AxiosClient
    ReactApp --> PublicIndex
    ReactApp --> PublicManifest
    ReactApp -->|"calls API"| APIEntry
    APIEntry -->|"handles requests"| ArticleController
    APIEntry --> AuthController
    APIEntry --> QuizController
    APIEntry --> FollowController
    APIEntry --> CommentController
    APIEntry --> HashTagController
    APIEntry --> CardSetController
    APIEntry --> UserController
    APIEntry --> AdminController
    APIEntry --> FileController
    ArticleController -->|"business logic"| ServiceLayer
    FileController --> FileService
    ServiceLayer --> MySQL
    RedisService --> Redis
    FileService --> S3
    Browser -->|"OAuth2 flow"| Kakao
    AuthController -->|"issue JWT"| JwtFilter
    Browser -->|"includes JWT"| AuthController
    GitHubActions -->|"runs on push"| DockerCompose

    %% Click Events
    click ReactApp "https://github.com/kimjongha99/knowledge-sharing/blob/main/front-end/src/App.tsx"
    click ReactIndex "https://github.com/kimjongha99/knowledge-sharing/blob/main/front-end/src/index.tsx"
    click AxiosClient "https://github.com/kimjongha99/knowledge-sharing/blob/main/front-end/src/api/axios.ts"
    click TailwindConfig "https://github.com/kimjongha99/knowledge-sharing/blob/main/front-end/tailwind.config.js"
    click PublicIndex "https://github.com/kimjongha99/knowledge-sharing/blob/main/front-end/public/index.html"
    click PublicManifest "https://github.com/kimjongha99/knowledge-sharing/blob/main/front-end/public/manifest.json"
    click APIEntry "https://github.com/kimjongha99/knowledge-sharing/blob/main/knowledge-sharing/src/main/java/com/hanghae/knowledgesharing/KnowledgeSharingApplication.java"
    click ArticleController "https://github.com/kimjongha99/knowledge-sharing/blob/main/knowledge-sharing/src/main/java/com/hanghae/knowledgesharing/article/controller/ArticleController.java"
    click AuthController "https://github.com/kimjongha99/knowledge-sharing/blob/main/knowledge-sharing/src/main/java/com/hanghae/knowledgesharing/auth/controller/AuthController.java"
    click QuizController "https://github.com/kimjongha99/knowledge-sharing/blob/main/knowledge-sharing/src/main/java/com/hanghae/knowledgesharing/quiz/controller/QuizController.java"
    click FollowController "https://github.com/kimjongha99/knowledge-sharing/blob/main/knowledge-sharing/src/main/java/com/hanghae/knowledgesharing/follow/controller/FollowController.java"
    click CommentController "https://github.com/kimjongha99/knowledge-sharing/blob/main/knowledge-sharing/src/main/java/com/hanghae/knowledgesharing/comment/controller/CommentController.java"
    click HashTagController "https://github.com/kimjongha99/knowledge-sharing/blob/main/knowledge-sharing/src/main/java/com/hanghae/knowledgesharing/hashtag/controller/HashTagController.java"
    click CardSetController "https://github.com/kimjongha99/knowledge-sharing/blob/main/knowledge-sharing/src/main/java/com/hanghae/knowledgesharing/cardSet/controller/CardSetController.java"
    click UserController "https://github.com/kimjongha99/knowledge-sharing/blob/main/knowledge-sharing/src/main/java/com/hanghae/knowledgesharing/user/controller/UserController.java"
    click AdminController "https://github.com/kimjongha99/knowledge-sharing/blob/main/knowledge-sharing/src/main/java/com/hanghae/knowledgesharing/admin/controller/AdminController.java"
    click FileController "https://github.com/kimjongha99/knowledge-sharing/blob/main/knowledge-sharing/src/main/java/com/hanghae/knowledgesharing/common/util/s3/controller/FileController.java"
    click ServiceLayer "https://github.com/kimjongha99/knowledge-sharing/blob/main/knowledge-sharing/src/main/java/com/hanghae/knowledgesharing/article/sevice/ArticleService.java"
    click FileService "https://github.com/kimjongha99/knowledge-sharing/blob/main/knowledge-sharing/src/main/java/com/hanghae/knowledgesharing/common/util/s3/service/FileService.java"
    click RedisService "https://github.com/kimjongha99/knowledge-sharing/blob/main/knowledge-sharing/src/main/java/com/hanghae/knowledgesharing/common/util/redis/RedisService.java"
    click WebSecurityConfig "https://github.com/kimjongha99/knowledge-sharing/blob/main/knowledge-sharing/src/main/java/com/hanghae/knowledgesharing/common/config/WebSecurityConfig.java"
    click JwtFilter "https://github.com/kimjongha99/knowledge-sharing/blob/main/knowledge-sharing/src/main/java/com/hanghae/knowledgesharing/common/jwt/JwtAuthenticationFilter.java"
    click OAuth2Handler "https://github.com/kimjongha99/knowledge-sharing/blob/main/knowledge-sharing/src/main/java/com/hanghae/knowledgesharing/auth/handler/OAuth2SuccessHandler.java"
    click S3Config "https://github.com/kimjongha99/knowledge-sharing/blob/main/knowledge-sharing/src/main/java/com/hanghae/knowledgesharing/common/config/S3Config.java"
    click SwaggerConfig "https://github.com/kimjongha99/knowledge-sharing/blob/main/knowledge-sharing/src/main/java/com/hanghae/knowledgesharing/common/config/SwaggerConfig.java"
    click QueryDslConfig "https://github.com/kimjongha99/knowledge-sharing/blob/main/knowledge-sharing/src/main/java/com/hanghae/knowledgesharing/common/config/QueryDslConfig.java"
    click JasyptConfig "https://github.com/kimjongha99/knowledge-sharing/blob/main/knowledge-sharing/src/main/java/com/hanghae/knowledgesharing/common/config/JasyptConfig.java"
    click RedisConfig "https://github.com/kimjongha99/knowledge-sharing/blob/main/knowledge-sharing/src/main/java/com/hanghae/knowledgesharing/common/util/redis/RedisConfig.java"
    click DockerCompose "https://github.com/kimjongha99/knowledge-sharing/blob/main/docker-compose.yml"
    click GitHubActions "https://github.com/kimjongha99/knowledge-sharing/blob/main/.github/workflows/GradleCI.yml"

    %% Styles
    classDef frontend fill:#ADD8E6,stroke:#000
    classDef backend fill:#90EE90,stroke:#000
    classDef persistence fill:#FFA500,stroke:#000
    classDef external fill:#FFFF00,stroke:#000
    classDef cicd fill:#D3D3D3,stroke:#000
```
