# qiushizhou/resumeapi architecture

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

- Interactive diagram: https://gitdiagram.com/qiushizhou/resumeapi
- Repository: https://github.com/qiushizhou/resumeapi

## Overview

##### Project type and purpose
- This is a full-stack, AI-powered resume optimization platform.
- Frontend: React/TypeScript single-page application served via Nginx.
- Backend: Flask microservice exposing RESTful APIs for parsing, analyzing, optimizing, and PDF generation.
- AI integration: OpenAI GPT models for content optimization.
- Data stores: file upload directory (volume) and optional MongoDB for persistence.

##### File structure
- Top level:
- docker-compose.yml orchestrates two services (`resume-frontend`, `resume-backend`).
- .github/workflows contains CI/CD pipeline for build and push.
- resume-frontend:
- Dockerfile + nginx.conf serve compiled React app.
- src/components implements UI (Auth, Resume editor, preview, controls).
- services/api.ts handles Axios calls to backend.
- resume_backend:
- Dockerfile and app.py as the entrypoint.
- resume_parser.py, resume_analyzer.py, resume_pdf_generator.py implement core logic.
- swagger_config.py / swagger_docs.py expose API docs.
- test_*.py for unit tests.
- uploads/ directory mounted as volume for incoming PDF/Docx.

##### README for additional insights
- Confirms core user flows: drag-and-drop editing, AI optimization per section, job-target matching, export as PDF.
- Technology stack reinforces: React + Material-UI + Flask + OpenAI + MongoDB (optional).
- Deployment guide shows that containers run behind Nginx (frontend) and Flask on 8080 (backend).

##### Elements
- Blue for user/client layers
- Green for service containers
- Orange for data stores/volumes
- Purple for external dependencies (OpenAI, CI/CD)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% CI/CD Pipeline
    subgraph "CI/CD Pipeline" 
        CI_CD["GitHub Actions"]:::external
    end

    %% Orchestration
    Compose["Docker Compose"]:::service

    CI_CD -->|"triggers build/push"| Compose

    %% Frontend Layer
    subgraph "Frontend" 
        Browser["User’s Browser / Client"]:::client
        Nginx["Nginx Static Server"]:::service
        ReactApp["React SPA"]:::service

        Browser -->|"loads index.html"| Nginx
        Nginx -->|"serves bundle"| ReactApp
    end

    %% React Components
    subgraph "React Components" 
        Auth["GoogleLoginButton"]:::component
        Editor["ResumeEditor"]:::component
        Preview["ResumePreview"]:::component
        OptimizeBtn["OptimizeButton"]:::component
        APIClient["API Service"]:::api
    end

    ReactApp --> Auth
    ReactApp --> Editor
    ReactApp --> Preview
    ReactApp --> OptimizeBtn
    ReactApp --> APIClient

    %% Backend Layer
    subgraph "Backend" 
        FlaskApp["Flask API"]:::service
        subgraph "API Modules"
            Parser["Resume Parser"]:::module
            Analyzer["Resume Analyzer"]:::module
            PDFGen["Resume PDF Generator"]:::module
            SwaggerCfg["Swagger Config"]:::module
            SwaggerDocs["Swagger Docs"]:::module
        end
    end

    APIClient -->|"HTTPS /api/v1/ upload"| FlaskApp
    APIClient -->|"HTTPS /api/v1/optimize"| FlaskApp
    APIClient -->|"HTTPS /api/v1/analyze"| FlaskApp
    APIClient -->|"HTTPS /api/v1/export"| FlaskApp

    FlaskApp --> Parser
    Parser --> Analyzer
    Analyzer --> PDFGen
    FlaskApp --> SwaggerCfg
    FlaskApp --> SwaggerDocs

    %% Data Stores
    subgraph "Data Stores" 
        FileVol["File Upload Volume"]:::storage
        Mongo["MongoDB (optional)"]:::storage
    end

    Parser -->|"writes file"| FileVol
    FlaskApp -->|"reads/writes"| Mongo

    %% External Services
    subgraph "External Dependencies"
        OpenAI["OpenAI API"]:::external
    end

    Analyzer -->|"POST /optimize"| OpenAI

    %% Connections to orchestration
    Compose --> Frontend
    Compose --> Backend

    %% Click Events
    click Browser "https://github.com/qiushizhou/resumeapi/blob/main/resume-frontend/public/index.html"
    click Nginx "https://github.com/qiushizhou/resumeapi/blob/main/resume-frontend/nginx.conf"
    click ReactApp "https://github.com/qiushizhou/resumeapi/blob/main/resume-frontend/src/App.tsx"
    click Auth "https://github.com/qiushizhou/resumeapi/blob/main/resume-frontend/src/components/Auth/GoogleLoginButton.tsx"
    click Editor "https://github.com/qiushizhou/resumeapi/blob/main/resume-frontend/src/components/Resume/ResumeEditor.tsx"
    click Preview "https://github.com/qiushizhou/resumeapi/blob/main/resume-frontend/src/components/Resume/ResumePreview.tsx"
    click OptimizeBtn "https://github.com/qiushizhou/resumeapi/blob/main/resume-frontend/src/components/Resume/OptimizeButton.tsx"
    click APIClient "https://github.com/qiushizhou/resumeapi/blob/main/resume-frontend/src/services/api.ts"
    click Compose "https://github.com/qiushizhou/resumeapi/blob/main/docker-compose.yml"
    click FlaskApp "https://github.com/qiushizhou/resumeapi/blob/main/resume_backend/app.py"
    click Parser "https://github.com/qiushizhou/resumeapi/blob/main/resume_backend/resume_parser.py"
    click Analyzer "https://github.com/qiushizhou/resumeapi/blob/main/resume_backend/resume_analyzer.py"
    click PDFGen "https://github.com/qiushizhou/resumeapi/blob/main/resume_backend/resume_pdf_generator.py"
    click SwaggerCfg "https://github.com/qiushizhou/resumeapi/blob/main/resume_backend/swagger_config.py"
    click SwaggerDocs "https://github.com/qiushizhou/resumeapi/blob/main/resume_backend/swagger_docs.py"
    click Mongo "https://github.com/qiushizhou/resumeapi/blob/main/resume_backend/db.py"
    click CI_CD "https://github.com/qiushizhou/resumeapi/blob/main/.github/workflows/build-push.yml"

    %% Styles
    classDef client fill:#E0F7FA,stroke:#006064,color:#004D40
    classDef service fill:#E8F5E9,stroke:#2E7D32,color:#1B5E20
    classDef component fill:#FFF3E0,stroke:#EF6C00,color:#E65100
    classDef api fill:#E3F2FD,stroke:#1976D2,color:#0D47A1
    classDef module fill:#F3E5F5,stroke:#8E24AA,color:#4A148C
    classDef storage fill:#FFF8E1,stroke:#F9A825,color:#F57F17
    classDef external fill:#FCE4EC,stroke:#C2185B,color:#880E4F
```
