# gianfrancodemarco/resume-builder architecture

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

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

## Overview

##### Project type and purpose
- This is a modern single-page application (SPA) front-end only “Resume Builder” built with Vue 3, Vuetify 3 and TipTap.
- It runs entirely in the browser, offering a WYSIWYG editor, live preview, style customization, export to HTML/PDF/JSON, AI-based CV conversion, and local JSON import/export.

##### File structure
- Top-level files: index.html, package.json, Vue/Vite/Vitest configs, public assets → static SPA setup.
- src/
- src/main.js & src/router.js → app bootstrap & routing
- src/views/ → page‐level Vue components (LandingPage, EditorPage)
- src/components/EditorPage → reusable UI parts: ResumeEditor, ResumePreview, LateralMenu, dialogs, styles
- src/models → domain models (ResumeDataV1/V2, ResumeStyleV1)
- src/services → core business logic (ResumeService for state persistence, ExporterService for file exports, CVConversionService for AI conversion)
- src/assets → images/fonts, etc.
- src/test & __tests__ → automated unit tests

##### Readme insights
- Confirms front-end SPA with no backend; data never leaves the browser except when calling external AI APIs or downloading files.
- Features: dynamic sections, real-time preview, AI conversion via external AI models, export formats, mobile responsiveness.

##### Main components & interactions
a. Client Application (Browser)
- UI Layer (Vue views & components)
- Business Logic Layer (services)
- Data Layer (models + browser storage)
b. External Integrations
- AI Conversion API (e.g., OpenAI or similar)
- File System APIs (Browser download, PDF generator library)
c. Build & Deployment
- Dev: Vite dev server
- Prod: Static host (Netlify/GitHub Pages/CDN)

##### Architectural patterns & design principles
- Component-based organization (Vue’s declarative UI).
- MVVM-style separation:
- View (Vue components & Vuetify UI)
- ViewModel/Controller (services orchestrating data flow)
- Model (plain JS classes representing resume data/style)
- Single Responsibility: services encapsulate export, conversion, persistence.
- Dependency injection via module imports.
- Test coverage: unit tests co-located under __tests__.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Presentation Layer
    subgraph "Presentation Layer"
        direction TB
        App["App.vue"]:::ui
        Landing["LandingPage.vue"]:::ui
        EditorPg["EditorPage.vue"]:::ui
        ResumeEd["ResumeEditor.vue"]:::ui
        ResumePrev["ResumePreview.vue"]:::ui
        Menu["LateralMenu.vue"]:::ui
        Info["ResumeInfo.vue"]:::ui
        StyleComp["ResumeStyle.vue"]:::ui
        ConvertDlg["ConvertCVDialog.vue"]:::ui
        TipTap["TiptapEditor.vue"]:::ui
    end

    %% Business Logic Layer
    subgraph "Business Logic Layer"
        direction TB
        ResumeSvc["ResumeService"]:::svc
        ExportSvc["ExporterService"]:::svc
        CVConvSvc["CVConversionService"]:::svc
    end

    %% Data Layer
    subgraph "Data Layer"
        direction TB
        DataV1["ResumeDataV1"]:::data
        DataV2["ResumeDataV2"]:::data
        StyleModel["ResumeStyleV1"]:::data
        Storage[("Browser Storage")]:::data
    end

    %% External Layer
    subgraph "External Systems"
        direction TB
        AIApi[(AI Conversion API)]:::external
        FileApi[(Browser File API & PDF Generator)]:::external
    end

    %% Build & Deployment
    subgraph "Build & Deployment"
        direction TB
        Vite["Vite Dev Server"]:::deploy
        Vitest["Vitest Test Runner"]:::deploy
        StaticHost["Static Hosting (Netlify/GitHub Pages)"]:::deploy
    end

    %% Application Bootstrap & Routing
    subgraph "Bootstrap & Routing"
        direction TB
        MainJS["main.js"]:::deploy
        Router["router.js"]:::deploy
    end

    %% Presentation relationships
    App -->|renders| Landing
    App -->|routes to| EditorPg
    EditorPg -->|uses| ResumeEd
    EditorPg -->|uses| ResumePrev
    EditorPg -->|uses| Menu
    ResumeEd -->|includes| TipTap
    ResumeEd -->|imports styles| EditorStyles
    Menu -->|controls| Info
    Menu -->|controls| StyleComp
    ResumeEd -->|opens| ConvertDlg

    %% Services relationships
    ResumeEd -->|calls| ResumeSvc
    ResumePrev -->|binds to| ResumeSvc
    ResumeSvc -->|reads/writes| DataV1
    ResumeSvc -->|reads/writes| DataV2
    ResumeSvc -->|reads/writes| StyleModel
    ResumeSvc -->|persists to| Storage

    ResumeEd -->|calls| ExportSvc
    ExportSvc -->|exports to| FileApi

    ResumeEd -->|calls| CVConvSvc
    CVConvSvc -->|calls| AIApi
    CVConvSvc -->|updates| ResumeSvc

    %% Bootstrap
    App --> MainJS
    App --> Router

    %% Build & Deployment flows
    MainJS -->|dev start| Vite
    Vitest -->|tests| ResumeEd
    StaticHost -->|hosts| App

    %% Click Events
    click App "https://github.com/gianfrancodemarco/resume-builder/blob/main/src/App.vue"
    click App "https://github.com/gianfrancodemarco/resume-builder/blob/main/src/App.css"
    click Landing "https://github.com/gianfrancodemarco/resume-builder/blob/main/src/views/LandingPage.vue"
    click EditorPg "https://github.com/gianfrancodemarco/resume-builder/blob/main/src/views/EditorPage.vue"
    click EditorPg "https://github.com/gianfrancodemarco/resume-builder/blob/main/src/views/EditorPage.css"
    click MainJS "https://github.com/gianfrancodemarco/resume-builder/blob/main/src/main.js"
    click Router "https://github.com/gianfrancodemarco/resume-builder/blob/main/src/router.js"
    click ResumeEd "https://github.com/gianfrancodemarco/resume-builder/blob/main/src/components/EditorPage/ResumeEditor.vue"
    click ResumePrev "https://github.com/gianfrancodemarco/resume-builder/blob/main/src/components/EditorPage/ResumePreview.vue"
    click Menu "https://github.com/gianfrancodemarco/resume-builder/blob/main/src/components/EditorPage/LateralMenu.vue"
    click Info "https://github.com/gianfrancodemarco/resume-builder/blob/main/src/components/EditorPage/ResumeInfo.vue"
    click StyleComp "https://github.com/gianfrancodemarco/resume-builder/blob/main/src/components/EditorPage/ResumeStyle.vue"
    click ConvertDlg "https://github.com/gianfrancodemarco/resume-builder/blob/main/src/components/EditorPage/ConvertCVDialog.vue"
    click TipTap "https://github.com/gianfrancodemarco/resume-builder/blob/main/src/components/EditorPage/TiptapEditor.vue"
    click TipTap "https://github.com/gianfrancodemarco/resume-builder/blob/main/src/components/EditorPage/TiptapEditor.css"
    click EditorStyles "https://github.com/gianfrancodemarco/resume-builder/blob/main/src/components/EditorPage/ResumeEditorStyles.css"
    click DataV1 "https://github.com/gianfrancodemarco/resume-builder/blob/main/src/models/ResumeData/ResumeDataV1.js"
    click DataV2 "https://github.com/gianfrancodemarco/resume-builder/blob/main/src/models/ResumeData/ResumeDataV2.js"
    click StyleModel "https://github.com/gianfrancodemarco/resume-builder/blob/main/src/models/ResumeStyle/ResumeStyleV1.js"
    click ResumeSvc "https://github.com/gianfrancodemarco/resume-builder/blob/main/src/services/ResumeService.js"
    click ExportSvc "https://github.com/gianfrancodemarco/resume-builder/blob/main/src/services/ExporterService.js"
    click CVConvSvc "https://github.com/gianfrancodemarco/resume-builder/blob/main/src/services/CVConversionService.js"
    click Vite "https://github.com/gianfrancodemarco/resume-builder/blob/main/vite.config.js"
    click Vitest "https://github.com/gianfrancodemarco/resume-builder/blob/main/vitest.config.js"
    click StaticHost "https://github.com/gianfrancodemarco/resume-builder/blob/main/vue.config.js"

    %% Styles
    classDef ui fill:#D0E8FF,stroke:#333,stroke-width:1px
    classDef svc fill:#D0FFD0,stroke:#333,stroke-width:1px
    classDef data fill:#FFF2B2,stroke:#333,stroke-width:1px
    classDef external fill:#FFD0B2,stroke:#333,stroke-width:1px
    classDef deploy fill:#E0E0E0,stroke:#333,stroke-width:1px
```
