Skip to main content
Get FairMatch AI up and running quickly with this streamlined guide. You’ll have the application running locally in just a few steps.

​
Prerequisites

Before you begin, ensure you have the following installed:
  • Node.js (v18 or higher)
  • Python (3.9 or higher)
  • A Supabase instance (PostgreSQL)
  • Google Gemini API key

​
Quick installation

1

Clone the repository

Clone the FairMatch AI repository and navigate to the project directory:
git clone https://github.com/PriyanshuAgarwal1407/FairMatch-AI.git
cd FairMatch-AI
2

Run the quick start script

Execute the quick start script to set up your environment:
chmod +x quick_start.sh
./quick_start.sh
This script will:
  • Verify your Python and Node.js installations
  • Create a Python virtual environment
  • Install backend dependencies
  • Install frontend dependencies
  • Create a .env file from the template
3

Configure environment variables

Update the .env file in the backend directory with your API keys:
cd backend
nano .env
Add your credentials:
SUPABASE_URL=your_supabase_project_url
SUPABASE_KEY=your_supabase_anon_key
GEMINI_API_KEY=your_gemini_api_key
ZYND_API_KEY=your_zynd_api_key
4

Start the backend server

Open a terminal and start the FastAPI backend:
cd backend
source venv/bin/activate
python -m uvicorn main:app --reload --port 8000
The backend API will be available at http://localhost:8000
5

Start the frontend application

Open a new terminal and start the React frontend:
cd frontend
npm run dev
The frontend will be available at http://localhost:5173
6

Access the application

Open your browser and navigate to:

​
Optional: Start AI agents

For full functionality, you can start the AI agent services in separate terminals: 
cd backend
source venv/bin/activate

# Start individual agents
python agents/github_agent.py
python agents/interview_agent.py
python agents/integrity_agent.py
python agents/resume_agent.py

​
Next steps

Now that FairMatch AI is running, you can:
  • Create a company account and post job listings
  • Register as a candidate and upload your resume
  • Explore the AI-powered evaluation pipeline
  • Review the configuration options for advanced setup

Build docs developers (and LLMs) love

Get started for freeTalk to us