-
Notifications
You must be signed in to change notification settings - Fork 6
Home
This project is an AI-powered Resume Screening Platform that processes resumes in bulk, extracts key information, and scores candidates based on job requirements β exposed via secure backend APIs and a React-based frontend.
- Upload multiple resumes at once (
.pdf,.docx) - Extracts key candidate information:
- Skills
- Experience
- Education
- Work history / summary
- Sends structured data to an internal AI engine to generate:
- Candidate score
- Match summary
- Strengths / risks (reasoning)
- Returns clean, structured responses that the frontend can display in tables, lists, or dashboards.
The backend logic, prompts, and internal processing pipeline are private.
Only the API contract and allowed usage are exposed in this documentation.
- Frontend: React + Vite (JavaScript)
- Backend Access: RESTful APIs (FastAPI-based, private repository)
- Database: Managed internally (not exposed in docs)
- AI Engine: Private scoring & summarization pipeline (accessed only via API)
This wiki is focused on what frontend contributors and API consumers need.
- Overview β High-level system summary and purpose (you are here)
- API Reference β List of available endpoints and usage rules
- API Data Contracts β Request/response JSON structures
- Frontend Integration Guide β How to call APIs from React/Vite
- Configuration β Frontend environment variables (e.g. API base URL, auth config)
- Troubleshooting & FAQ β Common problems and how to handle API errors
Internal pages like
Architecture,Database Schema, or internalSecurity Design
are intentionally not documented here to keep the backend private.
If you're new to this project:
- Start with API Reference to understand what endpoints are available.
- Read API Data Contracts to see the exact JSON structures youβll receive and send.
- Follow Frontend Integration Guide to connect the UI to the backend APIs.
You do not need access to backend code or database design to work on the frontend or API integration.
Author: Surendra Reddy
Project: AI Resume Screening