Skip to content

Latest commit

 

History

History
125 lines (92 loc) · 3.46 KB

README.md

File metadata and controls

125 lines (92 loc) · 3.46 KB

CV-Vacancy Matcher

A system for matching job candidates with vacancies using AI-powered analysis. The project consists of a FastAPI backend service and a Streamlit frontend application.

Design Documentation

For detailed information about the system architecture, components, and technical decisions, please refer to our Design Document. This document outlines the core system design, architecture decisions, and implementation details for developers and technical stakeholders.

Repository Structure

.
├── src/
│   ├── app/              # Streamlit frontend application
│   │   ├── streamlit_app.py
│   │   └── __init__.py
│   ├── service/          # Backend service
│   │   ├── app.py
│   │   ├── models.py
│   │   ├── test_api.py
│   │   └── __init__.py
│   └── platform/         # Core platform functionality
│       ├── lm_predictor.py
│       ├── prompts/
│       └── ...
├── notebooks/           # Jupyter notebooks
├── misc/               # Demo and example files
├── poetry.lock
├── pyproject.toml
├── requirements.txt
├── Dockerfile.fastapi
└── Dockerfile.streamlit

Setup

This project uses Poetry for dependency management. Follow these steps to set up your development environment:

  1. Install Poetry if you haven't already:

    curl -sSL https://install.python-poetry.org | python3 -

  2. Clone the repository and install dependencies:

    git clone <repository-url>
cd <repository-name>
poetry install

  3. Install pre-commit hooks:

    poetry run pre-commit install

Running the Application

Demo

Demo

Watch the demo above to see the CV-Vacancy Matcher in action.

Backend Service

  1. Start the FastAPI backend server:

    poetry run uvicorn src.service.app:app --reload

    The API will be available at http://localhost:8000

Frontend Application

  1. Make sure the backend service is running

  2. In a new terminal, start the Streamlit app:

    poetry run streamlit run src/app/streamlit_app.py

    The Streamlit interface will be available at http://localhost:8501

Development

Code Quality

We use several tools to maintain code quality:

  • isort: Import sorting
  • ruff: Linting
  • mypy: Type checking
  • poetry-export: Dependencies management

Run all pre-commit checks:

poetry run pre-commit run --all-files

Or run individual checks:

poetry run pre-commit run isort --all-files
poetry run pre-commit run ruff --all-files
poetry run pre-commit run mypy --all-files
poetry run pre-commit run poetry-export --all-files

Testing

Run tests using pytest:

poetry run pytest

License

This project is licensed under the Creative Commons Attribution 4.0 International License (CC BY 4.0).

This means you are free to:

  • Share — copy and redistribute the material in any medium or format
  • Adapt — remix, transform, and build upon the material for any purpose, even commercially

Under the following terms:

  • Attribution — You must give appropriate credit to the original authors, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.

See the LICENSE file in the repository root for the full license text.