Skip to content

Latest commit

 

History

History
219 lines (149 loc) · 9.48 KB

README.md

File metadata and controls

219 lines (149 loc) · 9.48 KB
Raw

IntelliMatch-AI-ATS: The Ultimate ATS Companion

IntelliMatch AI-ATS: Application tracking system which helps aligning resume with the job description and the keywords with the help of Google Gemini Pro LLM.

IntelliMatch-AI-ATS is a state-of-the-art Streamlit application designed to empower job seekers in conquering Applicant Tracking Systems (ATS) with unmatched precision and insight. This README provides comprehensive guidance on setting up and utilizing IntelliMatch-AI-ATS to enhance your job application process.

image

Table of Contents

Prerequisites

Before you begin with IntelliMatch-AI-ATS, ensure you have the following prerequisites on your system:

  • Python 3.7 or higher
  • An active Google Gemini Pro API Key
  • Streamlit python package installed and configured
  • The following Python packages (installable via pip):
    • streamlit
    • PyPDF2 - for processing PDF files
    • Pillow - for image processing
    • python-dotenv - for environment variable management
    • pybase64 - for encoding images in base64 format

Installation

To install IntelliMatch-AI-ATS, follow these steps:

  1. Clone the IntelliMatch-AI-ATS repository to your local machine:

    git clone https://github.com/vivifyhealthcare/IntelliMatch-AI-ATS
cd IntelliMatch-AI-ATS

  2. Set up a Python virtual environment (recommended):

    python -m venv venv
source venv/bin/activate  # For Windows, use `venv\Scripts\activate`

  3. Install the required Python packages:

    pip install -r requirements.txt

  4. Create a .env file in the root directory and add your GOOGLE_API_KEY:

    GOOGLE_API_KEY='YourGoogleAPIKeyHere'

  5. (Optional) Customize the background.JPG and any CSS styles in the styles/main.css file to personalize your application.

Getting Started

After installation, you can start ATSPro by running the Streamlit application:

streamlit run app.py

Usage

IntelliMatch-AI-ATS facilitates a variety of functionalities tailored to enhance your resume and prepare you for job applications:

  • Resume MAtch Percentage: Upload your resume and paste the job description to receive detailed feedback on how well your resume matches the job requirements.

  • Missing Keywords: Get a quantifiable match percentage indicating how closely your resume aligns with the job description, along with matched and missing keywords.

  • Skills Improvement: Receive suggestions on skills to improve or acquire based on the job description and your current resume.

  • Customization Tips: Obtain tailored advice on editing your resume bullet points to better match the job description.

  • Interview Prep: Access custom-generated interview questions and suggested answers based on your resume and the job role.

Features

  • Resume to Job Description Matching: Utilizes Google's Generative AI to compare your resume against job descriptions, identifying strengths and areas for improvement.

  • Interactive UI: Streamlit-powered interface for easy upload of resumes, input of job descriptions, and interaction with the application's features.

  • Dynamic Content Generation: Generates custom content such as interview prep questions and resume customization tips using advanced AI models.

  • Visual Customizations: Supports background image customization and CSS styling for a personalized user experience.

Email Subscription

image

Features

  • Subscription: Users can subscribe using their email address to receive notifications.
  • Login: Existing users can log into the system by providing their credentials.

Installation

To run this application, run the main.py file and install the required Python packages.

pip install streamlit requests

After installation, you can start ATSPro by running the Streamlit application:

streamlit run app.py

Subscribing

  • Enter your email in the 'Enter Your Email' input box id it's your first time accessing IntelliMatch-AI-ATS.
  • Click the 'Subscribe' button to subscribe and an email will be sent with signup and otp subscription.

OTP Subscription

image

The IntelliMatch-AI-ATS includes an email subscription feature that allows users to receive updates and notifications via email. This feature requires users to subscribe with their email address, verify their identity through an OTP (One-Time Password), and log in to access personalized content.

Subscribing and OTP Verification

To subscribe to IntelliMatch-AI-ATS:

  1. Enter Your Email: Go to the subscription section in the application and enter your email in the provided text input box.
  2. Subscribe: Click the 'Subscribe' button. This will trigger the system to send an OTP to your email as part of the subscription confirmation process.
  3. Enter OTP: Once you receive the OTP via email, enter it in the OTP input box.
  4. Verify OTP: Click the 'Login' button after entering the OTP to complete the verification process. If the OTP is correct, you will be logged in to the system. If the OTP is incorrect, you will have the option to resend a new OTP or try again.

Email and OTP Handling

The application handles the email and OTP processes using the following endpoints:

  • Subscription Endpoint: http://45.79.121.132:8001/SubscribeAndFeedback/Otpgenerate/
  • OTP Verification Endpoint: http://45.79.121.132:8001/SubscribeAndFeedback/OtpVerfication/ These endpoints are integrated into the Streamlit UI, making the process seamless for the user.

Error Handling

  • Subscription Errors: If there is an issue with the subscription request, the application will inform the user to try subscribing again.
  • OTP Errors: If the entered OTP is incorrect, the user will receive an error message and have the option to enter the OTP again or request a new one.

Installation

To ensure the email subscription feature works correctly, install the required packages:

pip install streamlit requests

After installation, you can start the IntelliMatch-AI-ATS application by running:

streamlit run app.py

This will launch the application in your web browser, where you can interact with the email subscription feature and other functionalities provided by IntelliMatch-AI-ATS.

Email Login

IntelliMatch-AI-ATS Email Login

IntelliMatch-AI-ATS offers a robust email subscription feature, allowing users to access personalized updates and notifications after verifying their email through an OTP (One-Time Password) system. This document provides instructions on how to subscribe, verify OTP, and handle potential errors.

Features

Subscribing and OTP Verification

To use the IntelliMatch-AI-ATS service, follow these steps:

  1. Enter Your Email: Navigate to the subscription section and input your email in the provided field.
  2. Subscribe: Click the 'Subscribe' button to send an OTP to your email, initiating the verification process.
  3. Enter OTP: After receiving your OTP via email, enter it in the designated input box on the application.
  4. Verify OTP: Press the 'Login' button after inputting the OTP. Successful verification will log you into the system, while an incorrect OTP will give you the option to retry or resend a new OTP.

Email and OTP Handling

The system uses the following endpoints to manage email subscriptions and OTP verification:

  • Subscription Endpoint: http://45.79.121.132:8001/SubscribeAndFeedback/Otpgenerate/
  • OTP Verification Endpoint: http://45.79.121.132:8001/SubscribeAndFeedback/OtpVerfication/

These endpoints integrate seamlessly into the Streamlit UI, ensuring a smooth user experience.

Error Handling

  • Subscription Errors: Should any issues arise during subscription, the application advises the user to attempt subscribing again.
  • OTP Errors: If an entered OTP is incorrect, an error message will appear with options to either retry entering the OTP or request a new one.

Installation

Ensure you have the necessary packages installed to operate the subscription feature:

pip install streamlit requests

Running the Application

Launch IntelliMatch-AI-ATS by executing:

streamlit run app.py

This command starts the application in your web browser, allowing you to interact with the email subscription service and explore other functionalities of IntelliMatch-AI-ATS.

Contributing

Contributions to IntelliMatch-AI-ATS are welcome! If you'd like to contribute, please follow these steps:

  1. Fork the repository to your own GitHub account.
  2. Create a new branch for your feature or bug fix.
  3. Commit your changes and push them to your fork.
  4. Submit a pull request with a clear description of your changes.