recruitment-process-back

Бэкенд CRM для HR

О проекте:

Meeting ROOM – веб-интерфейс для HR в крупных компаниях. Поможет HR упростить процесс найма сотрудников с помощью CRM-платформы.

Оглавление:

• Бэкенд CRM для HR
  • О проекте:
  • Оглавление:
  • Запуск приложения
    • Запуск приложения на локальном сервере
    • Запуск тестов:
    • Документация API доступна по адресам:
    • Админка доступна по адресу:
    • Установка pre-commit hooks
      • Установка pre-commit
      • Установка hooks
    • Работа с commitizen
  • Используемые технологии
  • Авторы

Запуск приложения

Клонирование реппозитория

git clone git@github.com:recruitment-process/recruitment-process-back.git

Перейдите в папку с проектом recruitment-process-back, установите и запустите виртуальное окружение.

cd recruitment-process-back

python -m venv venv

• Если у вас Linux/MacOS

  source venv/bin/activate
  

• Если у вас windows

  source venv/Scripts/activate
  

Установка зависимостей

pip install -r requirements.txt

Применяем миграции:

python manage.py migrate

Создаем суперпользователя:

python manage.py createsuperuser

Запуск приложения на локальном сервере

Перейдите в папку crm_backend

cd crm_backend

• Если у вас windows

  python manage.py runserver

• Если у вас Linux/MacOS

  python3 manage.py runserver

Запуск тестов:

python manage.py test

Документация API доступна по адресам:

http://127.0.0.1:8000/api/schema/swagger-ui/

http://127.0.0.1:8000/api/schema/redoc/

Админка доступна по адресу:

http://127.0.0.1:8000/admin/

Установка pre-commit hooks

Для того, чтобы при каждом коммите выполнялись pre-commit проверки, необходимо:

• Установить pre-commit
• Установить pre-commit hooks

Установка pre-commit

Модуль pre-commit уже добавлен в requirements и должен установиться автоматически с виртуальным окружением.

Проверить установлен ли pre-commit можно командой (при активированном виртуальном окружении):

pre-commit --version
>> pre-commit 3.3.3

Если этого не произошло, то необходимо установить pre-commit:

pip install pre-commit

Установка hooks

Установка хуков:

pre-commit install --all

Установка хука для commitizen

pre-commit install --hook-type commit-msg

В дальнейшем, при выполнении команды git commit будут выполняться проверки, перечисленные в файле .pre-commit-config.yaml.

Если не видно, какая именно ошибка мешает выполнить commit, можно запустить хуки вручную командой:

pre-commit run --all-files

Работа с commitizen

Чтобы сгенерировать установленный git-commit, запустите в вашем терминале

cz commit

или сочетание клавиш

cz c

Используемые технологии

• Python 3.10
• Django 4.1
• Django Rest Framework 3.14.0

Авторы

• Балахонова Марина
• Таргонский Михаил
• Попов Егор
• Ильин Иван