# mahdihasan2011/document-builder architecture

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

- Interactive diagram: https://gitdiagram.com/mahdihasan2011/document-builder
- Repository: https://github.com/mahdihasan2011/document-builder

## Overview

BD METRIX is a browser-based resume builder backed by a Laravel API. A user edits resume content, can request AI-generated summaries, skills, and experience or project bullets, previews the selected template, and can export a PDF. The UI can authenticate by phone OTP and save or reload resume data through the API. The excerpts show these principal calls and persistence behavior; they do not establish every route registration detail or the database engine, so those connections are limited to documented route references and model use.

Main entry points: [`resources/js/App.tsx`](https://github.com/mahdihasan2011/document-builder/blob/main/resources/js/App.tsx) (Builder workspace), [`resources/js/services/apiService.ts`](https://github.com/mahdihasan2011/document-builder/blob/main/resources/js/services/apiService.ts) (API client), [`resources/js/components/Editor.tsx`](https://github.com/mahdihasan2011/document-builder/blob/main/resources/js/components/Editor.tsx) (Resume editor), [`routes/api.php`](https://github.com/mahdihasan2011/document-builder/blob/main/routes/api.php) (API routes)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_frontend["Resume editor"]
  node_entry["React entry<br/>[index.tsx]"]
  node_app["Builder workspace<br/>[App.tsx]"]
  node_editor["Resume editor<br/>[Editor.tsx]"]
  node_templates["Template renderer"]
  node_authmodal["Phone sign-in<br/>[AuthModal.tsx]"]
  node_pdf["PDF export<br/>[App.tsx]"]
end

subgraph group_assist["AI assistance"]
  node_ai["AI writing service<br/>[geminiService.ts]"]
end

subgraph group_backend["API and persistence"]
  node_api["API client<br/>[apiService.ts]"]
  node_routes["API routes<br/>[api.php]"]
  node_auth["OTP controller<br/>[AuthController.php]"]
  node_resume["Resume controller"]
  node_user_model["User model<br/>[User.php]"]
  node_resume_model["Resume model<br/>[Resume.php]"]
  node_store[("Application database")]
end

subgraph group_contracts["Resume data"]
  node_types["Resume data types<br/>[types.ts]"]
end

node_user(("Resume author"))
node_gemini{{"Gemini API"}}

node_user -->|"uses"| node_entry
node_entry -->|"mounts"| node_app
node_app -->|"renders"| node_editor
node_app -->|"renders"| node_templates
node_app -->|"opens"| node_authmodal
node_app -->|"saves resume"| node_api
node_app -->|"exports PDF"| node_pdf
node_editor -->|"requests writing"| node_ai
node_ai -->|"generates text"| node_gemini
node_authmodal -->|"authenticates"| node_api
node_api -->|"calls API"| node_routes
node_routes -->|"routes auth"| node_auth
node_routes -->|"routes resume"| node_resume
node_auth -->|"creates user"| node_user_model
node_resume -->|"looks up user"| node_user_model
node_resume -->|"reads and writes"| node_resume_model
node_user_model -.->|"persists user"| node_store
node_resume_model -.->|"persists resume"| node_store
node_editor -->|"uses data shape"| node_types
node_templates -->|"uses data shape"| node_types
node_api -->|"uses data shape"| node_types

click node_entry "https://github.com/mahdihasan2011/document-builder/blob/main/resources/js/index.tsx"
click node_app "https://github.com/mahdihasan2011/document-builder/blob/main/resources/js/App.tsx"
click node_editor "https://github.com/mahdihasan2011/document-builder/blob/main/resources/js/components/Editor.tsx"
click node_templates "https://github.com/mahdihasan2011/document-builder/blob/main/resources/js/components/TemplateRenderer.tsx"
click node_authmodal "https://github.com/mahdihasan2011/document-builder/blob/main/resources/js/components/AuthModal.tsx"
click node_pdf "https://github.com/mahdihasan2011/document-builder/blob/main/resources/js/App.tsx"
click node_ai "https://github.com/mahdihasan2011/document-builder/blob/main/resources/js/services/geminiService.ts"
click node_api "https://github.com/mahdihasan2011/document-builder/blob/main/resources/js/services/apiService.ts"
click node_routes "https://github.com/mahdihasan2011/document-builder/blob/main/routes/api.php"
click node_auth "https://github.com/mahdihasan2011/document-builder/blob/main/app/Http/Controllers/Api/AuthController.php"
click node_resume "https://github.com/mahdihasan2011/document-builder/blob/main/app/Http/Controllers/Api/ResumeController.php"
click node_user_model "https://github.com/mahdihasan2011/document-builder/blob/main/app/Models/User.php"
click node_resume_model "https://github.com/mahdihasan2011/document-builder/blob/main/app/Models/Resume.php"
click node_store "https://github.com/mahdihasan2011/document-builder/blob/main/database/migrations/2025_01_01_000000_create_resumes_table.php"
click node_types "https://github.com/mahdihasan2011/document-builder/blob/main/resources/js/types.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_entry,node_app,node_editor,node_templates,node_authmodal,node_pdf toneBlue
class node_ai toneAmber
class node_api,node_routes,node_auth,node_resume,node_user_model,node_resume_model,node_store,node_gemini toneMint
class node_types toneRose
class node_user toneIndigo
```

## Components

### Resume editor

- [React entry](https://github.com/mahdihasan2011/document-builder/blob/main/resources/js/index.tsx): `resources/js/index.tsx`
- [Builder workspace](https://github.com/mahdihasan2011/document-builder/blob/main/resources/js/App.tsx): `resources/js/App.tsx`
- [Resume editor](https://github.com/mahdihasan2011/document-builder/blob/main/resources/js/components/Editor.tsx): `resources/js/components/Editor.tsx`
- [Template renderer](https://github.com/mahdihasan2011/document-builder/blob/main/resources/js/components/TemplateRenderer.tsx): `resources/js/components/TemplateRenderer.tsx`
- [Phone sign-in](https://github.com/mahdihasan2011/document-builder/blob/main/resources/js/components/AuthModal.tsx): `resources/js/components/AuthModal.tsx`
- [PDF export](https://github.com/mahdihasan2011/document-builder/blob/main/resources/js/App.tsx): `resources/js/App.tsx`

### AI assistance

- [AI writing service](https://github.com/mahdihasan2011/document-builder/blob/main/resources/js/services/geminiService.ts): `resources/js/services/geminiService.ts`

### API and persistence

- [API client](https://github.com/mahdihasan2011/document-builder/blob/main/resources/js/services/apiService.ts): `resources/js/services/apiService.ts`
- [API routes](https://github.com/mahdihasan2011/document-builder/blob/main/routes/api.php): `routes/api.php`
- [OTP controller](https://github.com/mahdihasan2011/document-builder/blob/main/app/Http/Controllers/Api/AuthController.php): `app/Http/Controllers/Api/AuthController.php`
- [Resume controller](https://github.com/mahdihasan2011/document-builder/blob/main/app/Http/Controllers/Api/ResumeController.php): `app/Http/Controllers/Api/ResumeController.php`
- [User model](https://github.com/mahdihasan2011/document-builder/blob/main/app/Models/User.php): `app/Models/User.php`
- [Resume model](https://github.com/mahdihasan2011/document-builder/blob/main/app/Models/Resume.php): `app/Models/Resume.php`
- [Application database](https://github.com/mahdihasan2011/document-builder/blob/main/database/migrations/2025_01_01_000000_create_resumes_table.php): `database/migrations/2025_01_01_000000_create_resumes_table.php`

### Resume data

- [Resume data types](https://github.com/mahdihasan2011/document-builder/blob/main/resources/js/types.ts): `resources/js/types.ts`

### Other components

- **Resume author**
- **Gemini API**

## Connections

- Resume author → React entry: uses
- React entry → Builder workspace: mounts (evidence: `resources/js/index.tsx`)
- Builder workspace → Resume editor: renders (evidence: `resources/js/App.tsx`)
- Builder workspace → Template renderer: renders (evidence: `resources/js/App.tsx`)
- Builder workspace → Phone sign-in: opens (evidence: `resources/js/App.tsx`)
- Builder workspace → API client: saves resume (evidence: `resources/js/App.tsx`)
- Builder workspace → PDF export: exports PDF (evidence: `resources/js/App.tsx`)
- Resume editor → AI writing service: requests writing (evidence: `resources/js/components/Editor.tsx`)
- AI writing service → Gemini API: generates text (evidence: `resources/js/services/geminiService.ts`)
- Phone sign-in → API client: authenticates (evidence: `resources/js/components/AuthModal.tsx`)
- API client → API routes: calls API (evidence: `resources/js/services/apiService.ts`)
- API routes → OTP controller: routes auth (evidence: `routes/api.php`)
- API routes → Resume controller: routes resume (evidence: `routes/api.php`)
- OTP controller → User model: creates user (evidence: `app/Http/Controllers/Api/AuthController.php`)
- Resume controller → User model: looks up user (evidence: `app/Http/Controllers/Api/ResumeController.php`)
- Resume controller → Resume model: reads and writes (evidence: `app/Http/Controllers/Api/ResumeController.php`)
- User model → Application database: persists user
- Resume model → Application database: persists resume
- Resume editor → Resume data types: uses data shape (evidence: `resources/js/components/Editor.tsx`)
- Template renderer → Resume data types: uses data shape (evidence: `resources/js/components/TemplateRenderer.tsx`)
- API client → Resume data types: uses data shape (evidence: `resources/js/services/apiService.ts`)
