# kvr-10/aiemail-assistant architecture

> Architecture diagram of the GitHub repository kvr-10/aiemail-assistant, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-25). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/kvr-10/aiemail-assistant
- Repository: https://github.com/kvr-10/aiemail-assistant

## Overview

##### Project type and purpose
- This is a full-stack AI-powered email reply generator with three main deliverables:
a) A Spring Boot backend (“AIEmail-writer”) exposing REST endpoints.
b) A React+Vite frontend (“AiEmail-Frontend”) for a web UI.
c) A browser extension (“AiEmail-writer-ext”) that injects an “AI Reply” button into Gmail.
- It integrates with OpenAI’s API for content generation and with Gmail via extension APIs.

##### File structure
- Top-level directories:
- AIEmail-writer: Maven/Spring Boot service
- AiEmail-Frontend: React/Vite web client
- docs: Static site assets and demo videos
- Key files:
- AIEmail-writer/src/main/java/.../app: controllers (EmailGeneratorController, HomeController), service (EmailGeneratorService), config (CorsConfig)
- application.properties: holds OPENAI_API_KEY
- Dockerfile & mvnw: containerization and build scripts
- package.json, vite.config.js: frontend build setup
- manifest.json, content.js/css: extension injection logic

##### README
- Describes features (tone customization, clipboard copy) and endpoints (/api/email/generate)
- Lists technology stack: Spring Boot, React, Material-UI, Axios, Firefox Extension API, Gmail API, Render, Netlify, Docker, GitHub Actions
- Deployment targets and CI/CD

##### Detail without overcomplication
- Logical unit: frontend app, backend controllers/services, extension scripts, external APIs, and deployment pipeline
- Cross-component interactions explicitly

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% User and Browser
    User["User"]:::external
    Browser["Browser (Chrome/Firefox)"]:::external

    User -->|"interacts with"| Browser

    %% Web Frontend Module
    subgraph "Web Frontend" 
        direction TB
        FEIndex["index.html"]:::frontend
        FEVite["vite.config.js"]:::frontend
        FEPkg["package.json"]:::frontend
        FEESLint["eslint.config.js"]:::frontend
        FEMain["src/main.jsx"]:::frontend
        FEApp["src/App.jsx"]:::frontend
        FEStyles1["src/App.css"]:::frontend
        FEStyles2["src/index.css"]:::frontend
        FEAssets["src/assets/"]:::frontend
        FEPublic["public/"]:::frontend
    end

    Browser -->|"HTTP/HTTPS"| FEIndex
    FEIndex --> FEMain
    FEMain --> FEApp
    FEApp -->|"calls REST API"| Backend

    %% Backend API Module
    subgraph "Backend API (Spring Boot)" 
        direction TB
        BEApp["AiEmailWriterApplication"]:::backend
        BEController1["EmailGeneratorController"]:::backend
        BEController2["HomeController"]:::backend
        BEService["EmailGeneratorService"]:::backend
        BECors["CorsConfig"]:::backend
        BEDTO["EmailRequest"]:::backend
        BEProps["application.properties"]:::backend
        BEPom["pom.xml"]:::backend
        BEDocker["Dockerfile"]:::infra
        BEMvnw["mvnw & wrapper files"]:::infra
    end

    FEApp -->|"/api/email/generate POST"| BEController1
    BEController1 --> BEService
    BEService -->|"calls OpenAI API"| OpenAI
    OpenAI -->|response| BEService
    BEService --> BEController1
    BEController1 --> FEApp
    BEController2 --> BEApp
    BECors --> BEApp

    %% Browser Extension Module
    subgraph "Browser Extension" 
        direction TB
        ExtManifest["manifest.json"]:::frontend
        ExtScript["content.js"]:::frontend
        ExtStyle["content.css"]:::frontend
        ExtIcons["icons/"]:::frontend
    end

    Browser -->|"inject AI Reply button"| ExtManifest
    ExtScript -->|"/api/email/generate POST"| BEController1
    ExtScript -->|"manipulates DOM via Gmail API"| GmailAPI

    %% Clipboard Feature
    FEApp -->|"copy to clipboard"| Clipboard["Clipboard"]:::external

    %% External Services
    subgraph "External Services"
        direction TB
        OpenAI["OpenAI API"]:::external
        GmailAPI["Gmail API"]:::external
    end

    %% Infrastructure & CI/CD
    subgraph "Infrastructure / Deployment"
        direction TB
        Netlify["Netlify (Frontend)"]:::infra
        Render["Render (Backend)"]:::infra
        GitHubActions["GitHub Actions (CI/CD)"]:::infra
    end

    FEIndex -->|deployed on| Netlify
    BEApp -->|container & deploy| Render
    BEPom --> BEDocker
    BEDocker --> Render
    GitHubActions --> Netlify
    GitHubActions --> Render

    %% Connections Summary
    Browser -.->|"runs extension"| ExtScript
    User -.->|"triggers UI"| FEApp

    %% Click Events - Backend
    click BEApp "https://github.com/kvr-10/aiemail-assistant/blob/master/AIEmail-writer/src/main/java/io/github/kvr_10/AIEmail_writer/AiEmailWriterApplication.java"
    click BEController1 "https://github.com/kvr-10/aiemail-assistant/blob/master/AIEmail-writer/src/main/java/io/github/kvr_10/AIEmail_writer/app/EmailGeneratorController.java"
    click BEController2 "https://github.com/kvr-10/aiemail-assistant/blob/master/AIEmail-writer/src/main/java/io/github/kvr_10/AIEmail_writer/app/HomeController.java"
    click BEService "https://github.com/kvr-10/aiemail-assistant/blob/master/AIEmail-writer/src/main/java/io/github/kvr_10/AIEmail_writer/app/EmailGeneratorService.java"
    click BECors "https://github.com/kvr-10/aiemail-assistant/blob/master/AIEmail-writer/src/main/java/io/github/kvr_10/AIEmail_writer/app/CorsConfig.java"
    click BEDTO "https://github.com/kvr-10/aiemail-assistant/blob/master/AIEmail-writer/src/main/java/io/github/kvr_10/AIEmail_writer/app/EmailRequest.java"
    click BEProps "https://github.com/kvr-10/aiemail-assistant/blob/master/AIEmail-writer/src/main/resources/application.properties"
    click BEPom "https://github.com/kvr-10/aiemail-assistant/blob/master/AIEmail-writer/pom.xml"
    click BEDocker "https://github.com/kvr-10/aiemail-assistant/tree/master/AIEmail-writer/Dockerfile"
    click BEMvnw "https://github.com/kvr-10/aiemail-assistant/tree/master/AIEmail-writer/mvnw"
    click BEMvnw "https://github.com/kvr-10/aiemail-assistant/blob/master/AIEmail-writer/mvnw.cmd"
    click BEMvnw "https://github.com/kvr-10/aiemail-assistant/blob/master/AIEmail-writer/.mvn/wrapper/maven-wrapper.properties"

    %% Click Events - Frontend
    click FEIndex "https://github.com/kvr-10/aiemail-assistant/blob/master/AiEmail-Frontend/index.html"
    click FEVite "https://github.com/kvr-10/aiemail-assistant/blob/master/AiEmail-Frontend/vite.config.js"
    click FEPkg "https://github.com/kvr-10/aiemail-assistant/blob/master/AiEmail-Frontend/package.json"
    click FEESLint "https://github.com/kvr-10/aiemail-assistant/blob/master/AiEmail-Frontend/eslint.config.js"
    click FEMain "https://github.com/kvr-10/aiemail-assistant/blob/master/AiEmail-Frontend/src/main.jsx"
    click FEApp "https://github.com/kvr-10/aiemail-assistant/blob/master/AiEmail-Frontend/src/App.jsx"
    click FEStyles1 "https://github.com/kvr-10/aiemail-assistant/blob/master/AiEmail-Frontend/src/App.css"
    click FEStyles2 "https://github.com/kvr-10/aiemail-assistant/blob/master/AiEmail-Frontend/src/index.css"
    click FEAssets "https://github.com/kvr-10/aiemail-assistant/tree/master/AiEmail-Frontend/src/assets/"
    click FEPublic "https://github.com/kvr-10/aiemail-assistant/tree/master/AiEmail-Frontend/public/"

    %% Click Events - Extension
    click ExtManifest "https://github.com/kvr-10/aiemail-assistant/blob/master/AiEmail-writer-ext/manifest.json"
    click ExtScript "https://github.com/kvr-10/aiemail-assistant/blob/master/AiEmail-writer-ext/content.js"
    click ExtStyle "https://github.com/kvr-10/aiemail-assistant/blob/master/AiEmail-writer-ext/content.css"
    click ExtIcons "https://github.com/kvr-10/aiemail-assistant/tree/master/AiEmail-writer-ext/icons/"

    %% Click Events - Documentation
    click DocsIndex "https://github.com/kvr-10/aiemail-assistant/blob/master/docs/index.html"
    click DocsAssets "https://github.com/kvr-10/aiemail-assistant/tree/master/docs/assets/"
    click DocsVideos "https://github.com/kvr-10/aiemail-assistant/blob/master/docs/videos/AiEmail_Assistant.mp4"
    click DocsScripts "https://github.com/kvr-10/aiemail-assistant/blob/master/docs/scripts/main.js"
    click DocsStyles "https://github.com/kvr-10/aiemail-assistant/blob/master/docs/styles/main.css"

    %% Class Definitions
    classDef frontend fill:#E8F4FD,stroke:#0288D1,stroke-width:1px
    classDef backend fill:#E3FCEF,stroke:#388E3C,stroke-width:1px
    classDef external fill:#FFF3E0,stroke:#F57C00,stroke-width:1px
    classDef infra fill:#ECEFF1,stroke:#607D8B,stroke-width:1px
```
