AI Resume Builder & Analyzer using NLP and ATS Optimization

Prerequisites

Before running the project, ensure you have the following installed:

• Git
• Python 3.10 or later
• Node.js 18+ and npm
• Virtual Environment (recommended)

Installation Steps

1. Clone the Repository

git clone https://github.com/HarshBathija-04/AI-Resume-Shortlister.git
cd AI-Resume-Shortlister

2. Create a Virtual Environment

Windows

python -m venv venv
venv\Scripts\activate

Linux/macOS

python3 -m venv venv
source venv/bin/activate

3. Install Backend Dependencies

pip install -r requirements.txt

4. Install Frontend Dependencies (if applicable)

cd frontend
npm install

5. Configure Environment Variables

Create a .env file in the project root and add the required environment variables.

Example:

SECRET_KEY=your_secret_key
DATABASE_URL=your_database_url
API_KEY=your_api_key

6. Start the Backend Server

For Flask:

flask run

or

python app.py

For Django:

python manage.py runserver

7. Start the Frontend

npm run dev

8. Open the Application

Frontend:

http://localhost:5173

Backend:

http://localhost:5000

(or the port configured in your application)

Usage Guide

1. Launch the application after completing the installation.
2. Create an account or log in to access the dashboard.
3. Upload your existing resume in PDF or DOCX format.
4. Paste or upload the target Job Description (JD) for analysis.
5. Click Analyze Resume to start the AI-powered evaluation.
6. The system will calculate your ATS score, extract important keywords, identify missing skills, and provide personalized improvement suggestions.
7. Review the recommendations and update your resume using the built-in resume builder or editor.
8. Generate a professional, ATS-friendly resume and export it in your preferred format.
9. Repeat the process for different job roles to maximize your chances of passing Applicant Tracking Systems (ATS).

Expected Output

• ATS Compatibility Score
• Keyword Match Analysis
• Missing Skills Report
• Resume Strengths & Weaknesses
• AI-Powered Improvement Suggestions
• Professionally Formatted Resume Ready for Job Applications

This workflow helps job seekers create optimized resumes, improve ATS rankings, and increase interview opportunities with AI-driven insights.

System Requirements

Operating System

• Windows 10/11 (64-bit)
• macOS 11 or later
• Ubuntu 20.04+ or any modern Linux distribution

Software Requirements

• Python 3.10 or later
• Node.js 18+ and npm
• Git
• Modern Web Browser (Google Chrome, Microsoft Edge, Firefox, or Safari)

Hardware Requirements

• Processor: Dual-Core 2.0 GHz or higher
• RAM: Minimum 4 GB (8 GB Recommended)
• Storage: At least 500 MB of free disk space
• Internet connection (required for installation, updates, and AI services if enabled)

Optional Requirements

• Visual Studio Code or any preferred code editor
• Virtual Environment (venv)
• Docker (optional for containerized deployment)

Supported File Formats

• Resume Upload: PDF, DOCX
• Job Description: TXT, DOCX, or plain text

These requirements ensure smooth installation, AI-powered resume analysis, ATS score generation, keyword extraction, and resume optimization across all supported platforms.