Installation Guide

Prerequisites

Before installing the project, ensure the following software is installed on your system:

• Node.js (v18 or later)
• npm (comes with Node.js)
• Git
• Visual Studio Code (recommended)
• Google Gemini API Key

Step 1: Clone the Repository

git clone https://github.com/yourusername/ai-resume-analyzer.git

Navigate to the project directory:

cd ai-resume-analyzer

Step 2: Install Frontend Dependencies

Navigate to the client folder:

cd client

Install the required packages:

npm install

Step 3: Install Backend Dependencies

Open a new terminal.

Navigate to the server folder:

cd server

Install the dependencies:

npm install

Step 4: Configure Environment Variables

Inside the server folder, create a .env file.

PORT=5000
GEMINI_API_KEY=YOUR_GEMINI_API_KEY

Replace YOUR_GEMINI_API_KEY with your Google Gemini API key.

Step 5: Start the Backend Server

Inside the server folder:

npm run dev

The backend server will start at:

http://localhost:5000

Step 6: Start the Frontend

Open another terminal.

Navigate to the client folder.

cd client
npm run dev

The frontend will run at:

http://localhost:5173

Step 7: Open the Application

Open your browser and visit:

http://localhost:5173

Project Workflow

1. Upload a PDF resume.
2. Resume text is extracted using PDF-Parse.
3. The extracted text is sent to the Google Gemini API.
4. AI analyzes the resume.
5. ATS score is generated.
6. Missing skills and keywords are identified.
7. Personalized improvement suggestions are displayed.

Project Structure

ai-resume-analyzer/
│
├── client/
│   ├── public/
│   ├── src/
│   ├── package.json
│   └── vite.config.js
│
├── server/
│   ├── routes/
│   ├── services/
│   ├── middleware/
│   ├── uploads/
│   ├── package.json
│   ├── server.js
│   └── .env
│
├── README.md
└── package.json

Build for Production

Frontend

cd client
npm run build

The production build will be generated in the dist folder.

Troubleshooting

Node Modules Missing

npm install

Invalid Gemini API Key

• Verify the API key in the .env file.
• Restart the backend server after updating the key.

Port Already in Use

Change the port in .env:

PORT=5001

User Instructions

Step 1: Launch the Application

• Start both the frontend and backend servers.
• Open your browser and navigate to the application URL (e.g., http://localhost:5173).

Step 2: Upload Your Resume

• Click the Upload Resume button.
• Select a resume in PDF format from your computer.
• Click Open to upload the file.

Step 3: Wait for Analysis

• The application extracts the resume text.
• The extracted content is securely sent to the Google Gemini API for AI-powered analysis.
• Processing typically takes a few seconds.

Step 4: View Analysis Results

After processing, the application displays:

• ATS Compatibility Score
• Resume Strengths
• Missing Technical Skills
• Missing Keywords
• Section-wise Feedback
• Personalized AI Recommendations

Step 5: Improve Your Resume

Review the suggestions provided by the AI and update your resume by:

• Adding missing skills
• Including relevant keywords
• Improving your professional summary
• Enhancing project and experience descriptions
• Organizing resume sections more effectively

Step 6: Re-analyze the Resume

Upload the updated resume again to receive a new analysis and verify that your ATS score has improved.

Best Practices

• Upload resumes only in PDF format.
• Ensure the resume text is selectable (avoid scanned image PDFs).
• Include your latest skills, education, projects, certifications, and work experience.
• Use a clear and professional resume format for better analysis.
• Review AI suggestions before making final changes.

Expected Output

The application provides:

• ATS Score
• AI-Powered Resume Analysis
• Missing Skills
• Missing Keywords
• Resume Strengths
• Improvement Suggestions
• Overall Resume Evaluation

Notes

• An active internet connection is required for AI analysis.
• A valid Google Gemini API Key must be configured in the backend.
• The application analyzes the uploaded resume and returns recommendations; it does not automatically modify the resume.

System Requirements

Hardware Requirements

• Intel Core i3 / AMD Ryzen 3 processor or higher
• Minimum 4 GB RAM (8 GB recommended)
• Minimum 500 MB free disk space
• Stable internet connection

Software Requirements

• Windows 10/11, Linux, or macOS
• Node.js (v18 or later)
• npm (v9 or later)
• Visual Studio Code (Recommended)
• Git
• Google Chrome, Microsoft Edge, or Mozilla Firefox

Frontend Requirements

• React.js
• Vite
• Tailwind CSS
• JavaScript (ES6+)

Backend Requirements

• Node.js
• Express.js
• Google Gemini API
• Multer
• PDF-Parse

Development Tools

• Visual Studio Code
• Git & GitHub
• Postman
• npm Package Manager

API Requirements

• Google Gemini API Key
• Active Internet Connection
• Configured .env file

Browser Compatibility

• Google Chrome
• Microsoft Edge
• Mozilla Firefox
• Brave Browser
• Opera Browser