rohitsrma / Resume-reviewer

The Resume Reviewer is a web application designed to provide feedback on resumes based on various criteria such as grammar, formatting, and professionalism.

Resume Reviewer

Overview

The Resume Reviewer is a web application designed to provide feedback on resumes based on various criteria such as grammar, formatting, and professionalism. This README document provides information on how to set up, use, and contribute to the project.

Table of Contents

• Installation
• Usage
• API Endpoints

Installation

To run the Resume Reviewer locally, follow these steps:

1. Create a Virtual Environment (Optional):

   python -m venv venv
   

2. Activate Virtual Environment:
   • On Windows:

     venv\Scripts\activate
     

   • On Mac:

     source venv/bin/activate
     

3. Clone the repository:

   git clone https://github.com/your-username/resume-reviewer.git
   

4. Navigate to the Project Directory:

   cd resume_feedback_project
   

5. Install Dependencies:

   pip install -r requirements.txt
   

6. Run development server:

   python manage.py runserver
   

Usage

Once the development server is running, you can access the application in your web browser at http://127.0.0.1:8000/.

API Usage

The image demonstrates a POST request to the API URL with a resume file (resume.pdf) and the resulting response containing the review feedback generated by the Resume Reviewer.

Watch a Demonstration

Watch Demonstration Video