# zhzkal2/piyak-hackathon architecture

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

- Interactive diagram: https://gitdiagram.com/zhzkal2/piyak-hackathon
- Repository: https://github.com/zhzkal2/piyak-hackathon

## Overview

##### High-Level Components

a) Client Layer (Frontend)
- React-based SPA
- Component structure for forms and user interface
- State management with Zustand

b) Server Layer (Backend)
- Spring Boot application
- REST API endpoints
- Authentication services
- Email services

c) External Services
- OpenAI GPT API
- SMTP Email Service
- Google OAuth

##### Detailed Component Breakdown

Frontend Components:
- Profile Management (Form1Picker through Form4Picker)
- Email Composition Interface
- Authentication Components (SocialLogin)
- Navigation (GNB, Header)
- State Management Store (useProfileStore, useUserInfo)

Backend Components:
- User Management Module
- OAuth Controller
- User Service
- Social Login Integration
- Email Module
- Email Controller
- Email Service
- ChatGPT Service
- Gmail Service
- Templates Module
- Templates Controller
- Templates Service
- Configuration Module
- REST Template Config
- Web Config

##### Flow Representation

Key flows:
##### User Authentication Flow
- Social Login → OAuth Controller → User Service
##### Email Generation Flow
- Frontend → Email Controller → ChatGPT Service → OpenAI API
##### Email Sending Flow
- Email Service → SMTP → External Email Server

##### Additional Elements

Supporting components:
- Database connections
- API Gateway/Entry points
- Security layers
- Caching mechanisms (if any)

##### Specific Implementation Details

Architectural patterns:
- MVC pattern in backend
- Component-based architecture in frontend
- Service-oriented architecture for email and AI integration

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Client["Client Layer"]
        direction TB
        UI["React SPA"]:::frontend
        Forms["Profile Forms"]:::frontend
        EmailUI["Email Interface"]:::frontend
        AuthUI["Authentication UI"]:::frontend
        Nav["Navigation"]:::frontend
        StateStore["State Management"]:::frontend
    end

    subgraph Server["Server Layer"]
        direction TB
        subgraph UserMgmt["User Management"]
            OAuthCtrl["OAuth Controller"]:::backend
            UserSvc["User Service"]:::backend
            SocialInt["Social Login Integration"]:::backend
        end

        subgraph EmailModule["Email Module"]
            EmailCtrl["Email Controller"]:::backend
            EmailSvc["Email Service"]:::backend
            ChatGPTSvc["ChatGPT Service"]:::backend
            GmailSvc["Gmail Service"]:::backend
        end

        subgraph Templates["Templates Module"]
            TempCtrl["Templates Controller"]:::backend
            TempSvc["Templates Service"]:::backend
        end

        subgraph Config["Configuration"]
            RestConfig["REST Template Config"]:::backend
            WebConfig["Web Config"]:::backend
        end
    end

    subgraph External["External Services"]
        OpenAI["OpenAI GPT API"]:::external
        SMTP["SMTP Service"]:::external
        GoogleOAuth["Google OAuth"]:::external
    end

    %% Client Layer Connections
    UI --> Forms
    UI --> EmailUI
    UI --> AuthUI
    UI --> Nav
    UI --> StateStore

    %% Server Layer Connections
    EmailUI --> EmailCtrl
    AuthUI --> OAuthCtrl
    Forms --> UserSvc
    
    %% Module Connections
    EmailCtrl --> EmailSvc
    EmailSvc --> ChatGPTSvc
    EmailSvc --> GmailSvc
    OAuthCtrl --> UserSvc
    UserSvc --> SocialInt
    TempCtrl --> TempSvc

    %% External Service Connections
    ChatGPTSvc --> OpenAI
    GmailSvc --> SMTP
    SocialInt --> GoogleOAuth

    %% Click Events
    click Forms "https://github.com/zhzkal2/piyak-hackathon/tree/main//frontend/src/components/Form1Picker"
    click Nav "https://github.com/zhzkal2/piyak-hackathon/tree/main//frontend/src/components/GNB"
    click AuthUI "https://github.com/zhzkal2/piyak-hackathon/tree/main//frontend/src/components/SocialLogin"
    click StateStore "https://github.com/zhzkal2/piyak-hackathon/blob/main//frontend/src/hooks/useProfileStore.js"
    click EmailUI "https://github.com/zhzkal2/piyak-hackathon/blob/main//frontend/src/pages/SendMail.jsx"
    click OAuthCtrl "https://github.com/zhzkal2/piyak-hackathon/blob/main//backend/src/main/java/com/example/backend/user/controller/OauthController.java"
    click UserSvc "https://github.com/zhzkal2/piyak-hackathon/blob/main//backend/src/main/java/com/example/backend/user/service/UserService.java"
    click SocialInt "https://github.com/zhzkal2/piyak-hackathon/blob/main//backend/src/main/java/com/example/backend/user/service/SocialOauth.java"
    click EmailCtrl "https://github.com/zhzkal2/piyak-hackathon/blob/main//backend/src/main/java/com/example/backend/mail/controller/EmailController.java"
    click EmailSvc "https://github.com/zhzkal2/piyak-hackathon/blob/main//backend/src/main/java/com/example/backend/mail/service/EmailService.java"
    click ChatGPTSvc "https://github.com/zhzkal2/piyak-hackathon/blob/main//backend/src/main/java/com/example/backend/mail/service/ChatGptService.java"
    click GmailSvc "https://github.com/zhzkal2/piyak-hackathon/blob/main//backend/src/main/java/com/example/backend/mail/service/GmailService.java"
    click TempCtrl "https://github.com/zhzkal2/piyak-hackathon/blob/main//backend/src/main/java/com/example/backend/templates/controller/TemplatesController.java"
    click TempSvc "https://github.com/zhzkal2/piyak-hackathon/blob/main//backend/src/main/java/com/example/backend/templates/service/TemplatesService.java"
    click RestConfig "https://github.com/zhzkal2/piyak-hackathon/blob/main//backend/src/main/java/com/example/backend/config/RestTemplateConfig.java"
    click WebConfig "https://github.com/zhzkal2/piyak-hackathon/blob/main//backend/src/main/java/com/example/backend/config/WebConfig.java"

    %% Styling
    classDef frontend fill:#2196F3,stroke:#1565C0,color:white
    classDef backend fill:#4CAF50,stroke:#2E7D32,color:white
    classDef external fill:#FFC107,stroke:#FFA000,color:black

    %% Legend
    subgraph Legend
        Frontend["Frontend Component"]:::frontend
        Backend["Backend Component"]:::backend
        ExternalSvc["External Service"]:::external
    end
```
