How varsharamanujam/hr-candidate-review-tool works
Main Components
a. Frontend:
• The frontend is built using React with additional styling support from Chakra UI and Tailwind CSS.
• Key directories include:
• src/ — Overall source code.
• src/components/ — Contains major UI components like the Carousel, Candidate Table, and Sidebar.
• src/api.js — Handles integration with backend API endpoints.
• Public assets such as index.html and public folder (likely for static assets).
• Build tooling is done using Vite with configuration files (vite.config.js, tailwind.config.js, postcss.config.js).
b. Backend:
• The backend is built in Python using the FastAPI framework.
• Key files include:
• backend/main.py — Contains the FastAPI application and route definitions.
• backend/database.py — Sets up the SQLite database, models, and connections.
• backend/run.py — Likely another way to start or manage the application.
• backend/test.py and test_files/ — For testing endpoints and functionality.
• backend/requirements.txt — Lists all Python dependencies.
c. External Services and Integration Points:
• The API endpoints described in the README (e.g., listing candidates, retrieving candidate details, generating PDFs, filtering) indicate clear integration points.
• There is data flow between the frontend (making requests) and backend (providing data via endpoints) using RESTful principles.
Relationships and Interactions
• Additionally, include the flow for generating candidate PDFs where the backend processes requests for PDF rendering.
• Testing components (backend/test.py and backend/test_files) support backend functionality but can be optionally drawn as a supporting/testing layer.
Architectural Patterns and Design Principles
• Separation of concerns: The system clearly separates the frontend (presentation) layer from the backend (business logic and database operations).
• RESTful design: The back end exposes clear endpoints following a REST API design.
• Modular design: The frontend and backend directory structures emphasize modularity (e.g., separating API calls, React components, test files).
• Use of modern build and deployment tools: Vite for frontend build, FastAPI for backend API, and testing utilities for both layers.
Relevant Technologies, Frameworks, and Libraries
• Frontend: React.js, Chakra UI, Tailwind CSS, Vite.
• Backend: Python, FastAPI, SQLite.
• Auxiliary: Node.js environment for the frontend, pip for Python dependencies.
• Frontend Block:
• “src” folder, highlighting key folders like “components” and “api”.
• Build tooling (Vite, Tailwind CSS) and note use of Chakra UI.
• Backend Block:
• FastAPI application (main.py) interacting with the SQLite database (via database.py).
• Individual services such as PDF generation and candidate filtering.
• A testing component to reflect backend/test.py and test files.
• Interaction Flow:
• Frontend makes HTTP requests → Backend endpoints respond → Database queries are executed.