Parse • Analyze • Optimize • Rewrite • Export

---

🎯 Overview

ResumeIQ is a production-ready AI-powered platform that helps software engineers and professionals optimize resumes for specific job descriptions.

The system performs:

• ATS Compatibility Analysis
• Resume-to-JD Matching
• Skill Gap Detection
• Keyword Analysis
• Resume Rewriting
• Professional Recommendation Generation
• Multi-format Report Exporting

---

✨ Core Features

📄 Intelligent Resume Parsing

• PDF Upload Support
• Instant Text Extraction
• Metadata Detection

🎯 ATS Compatibility Analysis

• Match Score Generation
• Keyword Coverage
• Recruiter Readability Evaluation

🤖 AI Resume Optimization

• Section Rewrite Suggestions
• Professional Improvements
• Skill Enhancement Recommendations

🔍 Gap Analysis

• Missing Skills Detection
• Missing Keywords
• Weak Section Identification

📝 AI Resume Rewriter

• Complete Resume Redrafting
• ATS Optimized Formatting
• Context-Aware Improvements

📊 Workspace & History

• Local Analysis Storage
• Search and Filter
• Quick Reopen

📤 Advanced Exporting

• PDF Reports
• PNG Snapshots
• Markdown
• JSON
• CSV
• TXT
• Multi-format Report Exporting

---

🛠 Technology Stack

Frontend

Technology	Purpose
React 19	UI Framework
TypeScript	Type Safety
Vite	Build Tool
Tailwind CSS	Styling
html2canvas	Snapshot Generation
jsPDF	PDF Export
Lucide React	Icons

---

Backend

Technology	Purpose
FastAPI	REST API
Python 3.11	Runtime
Pydantic	Validation
PyPDF2	PDF Parsing
HTTPX	API Communication
OpenAI SDK	OpenRouter Integration

---

AI Layer

Service	Usage
OpenRouter	Unified AI Gateway
Gemini 2.5 Flash	Fast Analysis
Claude 3.5 Sonnet	Detailed Reasoning
GPT Models	Alternative Analysis

---

🏗 System Architecture

graph TB

    User([👤 User])

    subgraph Frontend
        UI[React + TypeScript]
        Store[(Local Storage)]
        Export[Export Engine]
    end

    subgraph Backend
        API[FastAPI Server]
        Parser[PDF Parser]
        Validator[Pydantic Models]
    end

    subgraph AI
        OpenRouter[OpenRouter API]
        LLMs[Gemini / Claude / GPT]
    end

    User --> UI

    UI --> Store

    UI --> API

    API --> Parser

    API --> Validator

    API --> OpenRouter

    OpenRouter --> LLMs

    LLMs --> API

    API --> UI

    UI --> Export

Loading

---

🔄 Resume Analysis Workflow

flowchart LR

    A[Upload Resume PDF]
    B[Extract Resume Text]
    C[Paste Job Description]
    D[Send Analysis Request]
    E[OpenRouter AI Analysis]
    F[ATS Score Calculation]
    G[Gap Detection]
    H[Keyword Matching]
    I[Recommendations]
    J[Resume Rewriting]
    K[Export Results]

    A --> B
    B --> D
    C --> D
    D --> E

    E --> F
    E --> G
    E --> H

    F --> I
    G --> I
    H --> I

    I --> J
    J --> K

Loading

---

📁 Project Structure

ResumeIQ/
│
├── backend/
│   │
│   ├── analyzer.py               # AI analysis engine
│   ├── parser.py                 # PDF text extraction
│   ├── models.py                 # Pydantic schemas
│   ├── main.py                   # FastAPI application entry
│   ├── requirements.txt          # Python dependencies
│   ├── Dockerfile                # Backend container
│   ├── .env.example              # Environment template
│   └── .env                      # Local environment variables
│
├── frontend/
│   │
│   ├── public/
│   │
│   ├── src/
│   │   │
│   │   ├── api/
│   │   │   └── resumeApi.ts
│   │   │
│   │   ├── assets/
│   │   │   ├── hero.png
│   │   │   ├── react.svg
│   │   │   └── vite.svg
│   │   │
│   │   ├── components/
│   │   │   ├── ExportModal.tsx
│   │   │   ├── Header.tsx
│   │   │   ├── ImprovementCard.tsx
│   │   │   ├── Loader.tsx
│   │   │   ├── ModelSelector.tsx
│   │   │   ├── ResultPanel.tsx
│   │   │   ├── ResumeCharts.tsx
│   │   │   ├── ScoreCard.tsx
│   │   │   └── UploadZone.tsx
│   │   │
│   │   ├── pages/
│   │   │   ├── Home.tsx
│   │   │   ├── AnalysisDetail.tsx
│   │   │   └── HistoryWorkspace.tsx
│   │   │
│   │   ├── types/
│   │   │   └── index.ts
│   │   │
│   │   ├── utils/
│   │   │   └── history.ts
│   │   │
│   │   ├── App.tsx
│   │   ├── App.css
│   │   ├── main.tsx
│   │   └── index.css
│   │
│   ├── index.html
│   ├── package.json
│   ├── package-lock.json
│   ├── vite.config.ts
│   ├── tsconfig.json
│   ├── tsconfig.app.json
│   ├── tsconfig.node.json
│   ├── eslint.config.js
│   ├── Dockerfile
│   └── README.md
│
├── docker-compose.yml
├── .gitignore
└── README.md

---

🚀 Quick Start

1️⃣ Clone Repository

git clone https://github.com/LoganthP/ResumeIQ.git
cd ResumeIQ

---

⚙️ Environment Configuration

Create a .env file inside the backend/ directory:

OPENROUTER_API_KEY="your_openrouter_key_here"
OPENROUTER_MODEL=google/gemini-2.5-flash
OPENROUTER_BASE_URL=https://openrouter.ai/api/v1

APP_SITE_URL=http://localhost:5173
APP_SITE_NAME=ResumeIQ

Replace your_openrouter_key_here with your actual OpenRouter API key.

---

🔧 Backend Setup

Navigate to the backend directory:

cd backend

Create Virtual Environment

python -m venv venv

Activate Virtual Environment

Windows (PowerShell)

.\venv\Scripts\Activate.ps1

Windows (Command Prompt)

venv\Scripts\activate.bat

macOS / Linux

source venv/bin/activate

Install Dependencies

pip install -r requirements.txt

Create Environment File

Windows (Command Prompt)

copy .env.example .env

Windows (PowerShell) / macOS / Linux

cp .env.example .env

Update the .env file with your OpenRouter API key.

Start Backend Server

uvicorn main:app --reload

Backend URLs

Backend API:
http://localhost:8000

Swagger Documentation:
http://localhost:8000/docs

---

⚡ Quick Backend Start (Windows)

cd backend
python -m venv venv
.\venv\Scripts\activate
pip install -r requirements.txt
uvicorn main:app --reload

---

🎨 Frontend Setup

Open a new terminal window:

cd frontend

Install Dependencies

npm install

Start Development Server

npm run dev

Frontend URL

http://localhost:5173

---

🌐 Application Endpoints

Service	URL
Frontend	http://localhost:5173
Backend API	http://localhost:8000
API Documentation	http://localhost:8000/docs

---

🐳 Docker Setup

Build and Run

docker-compose up --build

Run in Detached Mode

docker-compose up -d

Stop Containers

docker-compose down

Access Services

Service	URL
Frontend	http://localhost:5173
Backend API	http://localhost:8000
API Documentation	http://localhost:8000/docs

---

🛣️ Roadmap

Planned Features

• User Authentication
• Cloud-Based Analysis History
• Resume Version Comparison
• Cover Letter Generator
• LinkedIn Profile Analysis
• Multi-Resume Management
• Team Collaboration Workspace
• ATS Simulation Engine
• One-Click Resume Export Templates

---

🛣️ Future Enhancements

• AI Cover Letter Generator
• LinkedIn Profile Analysis
• Resume Section-Level Scoring
• ATS Formatting Validation
• Resume Version Comparison
• Cloud-Based Analysis History
• User Authentication & Profiles
• GitHub Profile Integration
• AI Interview Preparation Assistant
• Personalized Career Recommendations
• Job Match Prediction
• Smart Resume Templates