Job Jotter

Job Jotter - проект, предназначенный для создания резюме и просмотра примеров резюме. С помощью нашего конструктора резюме вы можете создать свое резюме и получить его в виде PDF файла. Также проект включает проверку текста на ошибки с помощью OpenAI API (работает только с VPN).

Содержание

• Описание
• Основной функционал
• Технологии
• Установка
• Использование
• Вклад
• Лицензия

Описание

Job Jotter - инструмент для создания профессиональных резюме. Используйте наш конструктор резюме для создания и скачивания PDF версий ваших резюме. Проверка текста на ошибки осуществляется с использованием OpenAI API, что требует наличия VPN.

Основной функционал

• Создание резюме с помощью конструктора
• Экспорт резюме в PDF формат
• Проверка текста на ошибки с помощью OpenAI API (требуется VPN)

Технологии

Проект написан на языке Python 3.11. Используемые библиотеки и зависимости перечислены в requirements.txt:

pydantic~=2.7.1
pillow~=10.3.0
fastapi~=0.111.0
openai~=1.30.1
python-dotenv~=1.0.1
requests~=2.31.0
beautifulsoup4~=4.12.3
SQLAlchemy~=2.0.30
psycopg2-binary~=2.9.9

Установка

Для установки и запуска проекта выполните следующие шаги:

1. Клонируйте репозиторий:

   git clone https://github.com/BPE2301-4/backend.git

2. Перейдите в директорию проекта:

   cd backend

3. Создайте и активируйте виртуальное окружение:

   python -m venv venv
   source venv/bin/activate  # для Windows используйте `venv\Scripts\activate`

4. Установите зависимости:

   pip install -r requirements.txt

5. Настройте файл окружения .env для работы с OpenAI API и другими необходимыми переменными.

Использование

Для запуска сервера используйте команду:

uvicorn src.main:app

После запуска, вы сможете получить доступ к вашему приложению по адресу http://127.0.0.1:8000. Интерактивная документация доступна по адресу http://127.0.0.1:8000/docs.

Вклад

Если вы хотите внести свой вклад в проект:

1. Форкните репозиторий.
2. Создайте новую ветку:

   git checkout -b feature-branch

3. Внесите изменения и зафиксируйте их:

   git commit -m "Добавлен новый функционал"

4. Отправьте изменения в ваш форк:

   git push origin feature-branch

5. Создайте Pull Request.

Лицензия

Лицензия на данный проект отсутствует.