https://github.com/deepakb/job-flow
https://github.com/deepakb/job-flow
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/deepakb/job-flow
- Owner: deepakb
- Created: 2024-12-17T13:19:52.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-20T05:50:42.000Z (over 1 year ago)
- Last Synced: 2025-02-12T12:56:53.502Z (over 1 year ago)
- Language: Python
- Size: 129 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Job Flow API
A FastAPI-based backend for a job-matching platform that enables users to upload resumes, match jobs, receive insights, and handle notifications.
## Features
- User Management with Firebase Authentication
- Resume Parsing and Enhancement using OpenAI
- Job Aggregation and Matching
- Insights and Recommendations
- Real-time Notifications
## Setup
1. Install Poetry (if not already installed):
```bash
curl -sSL https://install.python-poetry.org | python3 -
```
2. Install dependencies:
```bash
poetry install
```
3. Copy `.env.example` to `.env` and update the values:
```bash
cp .env.example .env
```
4. Run the development server:
```bash
poetry run uvicorn src.main:app --reload
```
## API Documentation
Once the server is running, visit:
- Swagger UI: http://localhost:8000/docs
- ReDoc: http://localhost:8000/redoc
## Project Structure
```
src/
├── api/ # API routes
├── core/ # Core settings, middlewares, and utilities
├── models/ # Pydantic models
├── services/ # Business logic
├── repositories/ # Firebase integration
├── tests/ # Unit and integration tests
└── main.py # FastAPI application entry point
```
## Development
1. Run tests:
```bash
poetry run pytest
```
2. Format code:
```bash
poetry run black .
```
## License
MIT