# rrs301/ai-resume-builder architecture

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

- Interactive diagram: https://gitdiagram.com/rrs301/ai-resume-builder
- Repository: https://github.com/rrs301/ai-resume-builder

## Overview

##### Main Components

A. Frontend Layer:
- React Application (Built with Vite)
- Key UI Components:
- Authentication Module (/src/auth)
- Dashboard Module (/src/dashboard)
- Resume Editor (/src/dashboard/resume)
- Resume Preview (/src/my-resume)
- UI Component Library (/src/components/ui)
- Custom Components (/src/components/custom)

B. Service Layer:
- AI Service Integration (service/AIModal.js)
- Global API Service (service/GlobalApi.js)

C. State Management:
- Context API Implementation (ResumeInfoContext)

**[User Interface Layer]**

- [Authentication Module]

- [Core Application]
- [Dashboard]
- [Resume Editor]
- [Form Sections]
- Personal Details
- Experience
- Education
- Skills
- Summary

- [Preview Components]

- [Theme Customization]

- [Services Layer]
- AI Modal Service
- Global API Service

- [State Management]
- Resume Info Context

##### Key Relationships to Highlight

- How the Resume Editor components interact with the Preview components
- Connection between form components and the ResumeInfoContext
- Demonstrate how the AI service integrates with the form components
- Authentication flow's relationship with protected routes

##### Technical Stack Indicators

- React + Vite
- Tailwind CSS (based on configuration files)
- Context API for state management
- AI integration services
- Custom UI component library

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph UI["User Interface Layer"]
        Auth["Authentication Module"]
        Dashboard["Dashboard"]
        Editor["Resume Editor"]
        Preview["Resume Preview"]
        Theme["Theme Customization"]
    end

    subgraph Forms["Form Sections"]
        Personal["Personal Details"]
        Experience["Experience"]
        Education["Education"]
        Skills["Skills"]
        Summary["Summary"]
        RichText["Rich Text Editor"]
    end

    subgraph PreviewComponents["Preview Components"]
        PersPreview["Personal Preview"]
        ExpPreview["Experience Preview"]
        EduPreview["Education Preview"]
        SkillsPreview["Skills Preview"]
        SumPreview["Summary Preview"]
    end

    subgraph Components["Component Library"]
        UILib["UI Components"]
        CustomComp["Custom Components"]
    end

    subgraph Services["Services Layer"]
        AI["AI Modal Service"]
        GlobalAPI["Global API Service"]
    end

    subgraph State["State Management"]
        Context["Resume Info Context"]
    end

    UI --> Forms
    UI --> PreviewComponents
    Forms --> PreviewComponents
    Forms --> Context
    PreviewComponents --> Context
    Editor --> Forms
    Editor --> Theme
    Services --> Forms
    Components --> UI

    %% Style Definitions
    classDef frontend fill:#3498db,stroke:#2980b9,color:white
    classDef service fill:#2ecc71,stroke:#27ae60,color:white
    classDef state fill:#9b59b6,stroke:#8e44ad,color:white
    classDef preview fill:#e67e22,stroke:#d35400,color:white
    classDef form fill:#1abc9c,stroke:#16a085,color:white

    %% Apply Styles
    class UI,Dashboard,Editor,Preview,Theme frontend
    class Forms,Personal,Experience,Education,Skills,Summary,RichText form
    class PreviewComponents,PersPreview,ExpPreview,EduPreview,SkillsPreview,SumPreview preview
    class Services,AI,GlobalAPI service
    class State,Context state

    %% Click Events
    click Auth "https://github.com/rrs301/AI-Resume-Builder/blob/main/src/auth/sign-in/index.jsx"
    click Dashboard "https://github.com/rrs301/AI-Resume-Builder/blob/main/src/dashboard/index.jsx"
    click Editor "https://github.com/rrs301/AI-Resume-Builder/blob/main/src/dashboard/resume/[resumeId]/edit/index.jsx"
    click Personal "https://github.com/rrs301/AI-Resume-Builder/blob/main/src/dashboard/resume/components/forms/PersonalDetail.jsx"
    click Experience "https://github.com/rrs301/AI-Resume-Builder/blob/main/src/dashboard/resume/components/forms/Experience.jsx"
    click Education "https://github.com/rrs301/AI-Resume-Builder/blob/main/src/dashboard/resume/components/forms/Education.jsx"
    click Skills "https://github.com/rrs301/AI-Resume-Builder/blob/main/src/dashboard/resume/components/forms/Skills.jsx"
    click Summary "https://github.com/rrs301/AI-Resume-Builder/blob/main/src/dashboard/resume/components/forms/Summery.jsx"
    click PersPreview "https://github.com/rrs301/AI-Resume-Builder/blob/main/src/dashboard/resume/components/preview/PersonalDetailPreview.jsx"
    click ExpPreview "https://github.com/rrs301/AI-Resume-Builder/blob/main/src/dashboard/resume/components/preview/ExperiencePreview.jsx"
    click EduPreview "https://github.com/rrs301/AI-Resume-Builder/blob/main/src/dashboard/resume/components/preview/EducationalPreview.jsx"
    click SkillsPreview "https://github.com/rrs301/AI-Resume-Builder/blob/main/src/dashboard/resume/components/preview/SkillsPreview.jsx"
    click SumPreview "https://github.com/rrs301/AI-Resume-Builder/blob/main/src/dashboard/resume/components/preview/SummeryPreview.jsx"
    click UILib "https://github.com/rrs301/AI-Resume-Builder/tree/main/src/components/ui"
    click CustomComp "https://github.com/rrs301/AI-Resume-Builder/blob/main/src/components/custom/Header.jsx"
    click AI "https://github.com/rrs301/AI-Resume-Builder/blob/main/service/AIModal.js"
    click GlobalAPI "https://github.com/rrs301/AI-Resume-Builder/blob/main/service/GlobalApi.js"
    click Context "https://github.com/rrs301/AI-Resume-Builder/blob/main/src/context/ResumeInfoContext.jsx"
    click Theme "https://github.com/rrs301/AI-Resume-Builder/blob/main/src/dashboard/resume/components/ThemeColor.jsx"
    click RichText "https://github.com/rrs301/AI-Resume-Builder/blob/main/src/dashboard/resume/components/RichTextEditor.jsx"
    click Preview "https://github.com/rrs301/AI-Resume-Builder/blob/main/src/my-resume/[resumeId]/view/index.jsx"
```
