This repository contains a Resume Builder Application designed to assist users in creating, updating, and managing resumes tailored to specific job descriptions. The application consists of two main components:
- Backend API: Built using FastAPI and LangChain for intelligent resume generation.
- Frontend Application: A React-based interface powered by Vite for seamless user interaction.
- Resume Creation: Generates resumes based on user profiles, job descriptions, and templates using LangChain's AI capabilities.
- Resume Update: Enhances existing resumes to better match job requirements.
- Job Recommendations: Fetches job listings from external APIs and categorizes them.
- Interview Preparation Assistant: Provides chatbot functionality for interview practice.
- Interactive UI: Allows users to create, update, and view resumes.
- Job Listings: Displays job recommendations with filtering options.
- Chatbot Integration: Prepares users for interviews with an interactive assistant.
- TailwindCSS Styling: Ensures modern and responsive design.
-
Clone the repository:
git clone cd backend -
Set up a virtual environment:
python -m venv env source env/bin/activate # On Windows use `env\Scripts\activate`
-
Install dependencies:
pip install -r requirements.txt
-
Run the server:
uvicorn final_endpoints:app --host 0.0.0.0 --port 8000 --reload
-
Navigate to the
clientdirectory:cd client -
Install dependencies:
npm install
-
Start the development server:
npm run dev
POST /resume/create: Create a new resume.POST /resume/update: Update an existing resume.
GET /jobs: Fetch job listings.
POST /chat: Send a message to the chatbot.
GET /health: Verify API health.
- Open the application in your browser at
http://localhost:. - Navigate between sections:
- Resumes: View, create, or update resumes.
- Jobs: Explore job recommendations.
- Chatbot: Practice interview questions.
- FastAPI: For building RESTful APIs.
- LangChain: For AI-driven resume generation.
- Pydantic: For data validation.
- MongoDB/Ngrok Integration: External API connections.
- React + Vite: Modern frontend framework with fast build times.
- TailwindCSS: Responsive styling.
- Radix UI Components: Advanced UI elements.
- React Router DOM: Navigation management.
Environment variables are managed using .env files. Ensure you set up keys for external APIs (e.g., MongoDB, Ngrok).
TailwindCSS configuration is located in tailwind.config.js. Paths are defined in jsconfig.json.
Run unit tests using:
pytest tests/Run React component tests using:
npm testThis project is licensed under the MIT License. See the LICENSE file for details.
Contributions are welcome! Please follow these steps:
- Fork the repository.
- Create a feature branch (
git checkout -b feature-name). - Commit your changes (
git commit -m "Add new feature"). - Push to the branch (
git push origin feature-name). - Submit a pull request.