Skip to content

MostBridge/Bridge

Repository files navigation

bridge_workflow

Bridge

Bridge service for the Yandex Practicum, Career Tracker

Сервис найма в карьерном трекере, который предоставляет возможность партнерам работать с базой заинтересованных кандидатов.

Содержание

  1. Cведения о команде

  2. Cсылка на веб хостинг

  3. Подготовка к запуску

    3.1. Правила работы с git

    3.2. Настройка переменных окружения

    3.3. Запуск сервера локально

  4. Cтэк технологий

  5. Cсылки на сторонние библиотеки

1. Cведения о команде:

  1. Разработчик Сластухин Александр

  2. Разработчик и Тимлид Ярослав Андреев

2. Cсылка на веб хостинг

Сервис Bridge

  • Email:

Password:

hr_password

Swagger

3. Подготовка к запуску

Примечание: использование Docker, poetry.

3.1. Правила работы с git (как делать коммиты и pull request-ы):

  1. Две основные ветки: main и develop
  2. Ветка develop — “предрелизная”. Т.е. здесь должен быть рабочий и выверенный код
  3. Создавая новую ветку, наследуйтесь от ветки develop
  4. В main находится только production-ready код (CI/CD)
  5. Правила именования веток
    • весь новый функционал — feature/название-функционала
    • исправление ошибок — bugfix/название-багфикса
  6. Пушим свою ветку в репозиторий и открываем Pull Request

3.2. Настройка переменных окружения

Перед запуском проекта необходимо создать копию файла .env.example, назвав его .env и установить значение базы данных почты и тд.

Системные требования

  • Python 3.11+;
  • Docker (19.03.0+) c docker compose;
  • Poetry;

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

poetry install

3.3. Запуск сервера локально

Запуск сервера локально:

запуск сервиса:

make start

остановка сервиса:

make stop

остановка контейнера сервиса:

make clear

Базовая команда для запуска БД, миграций, сервиса:

docker exec backend-container-bridge make server-init

наполнение PostgreSQL тестовыми данными:

docker exec backend-container-bridge poetry run python manage.py loaddata fixtures/data.json

4 Cтэк технологий

Python Django Gunicorn Nginx Swagger Docker Postgres

5 Cторонние библиотеки

Poetry Ruff Pre-commit Djoser SimpleJWT Django-filter