hrspace-request-builder-backend

Проект развернут на удаленном сервере по адресу http://185.221.162.231:81

• админ панель доступна по адресу http://185.221.162.231/admin
• Swagger доступен по адресу http://185.221.162.231/docs
• Redoc доступен по адресу http://185.221.162.231/redoc

Оглавление

• Технологии
• Установка приложения
• Запуск тестов
• Запуск приложения
• Удаление приложения
• Авторы

Технологии

Подробнее

⬆️Оглавление

Установка приложения:

Предварительные условия

Предполагается, что пользователь установил Docker и Docker Compose на локальной машине. Проверить наличие можно выполнив команды:

docker --version && docker-compose --version

Клонируйте репозиторий с GitHub и введите данные для переменных окружения (значения даны для примера, но их можно оставить):

git clone https://github.com/hrspace-request-builder/hrspace-request-builder-backend.git
cd hrspace-request-builder-backend
cp env_example .env
nano .env

⬆️Оглавление

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

Из корневой директории проекта выполните команду запуска тестов:

docker compose -f tests/docker/test.docker-compose.yml --env-file .env up --build --abort-on-container-exit && \
docker compose -f tests/docker/test.docker-compose.yml --env-file .env down -v

После прохождения тестов в консоль будет выведен отчет pytest и coverage.

⬆️Оглавление

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

1. Из корневой директории проекта выполните команду:

docker compose -f docker/docker-compose.yml --env-file .env up -d --build

Проект будет развернут в docker-контейнерах по адресу http://localhost:81

Администрирование приложения может быть осуществлено:

• через Swagger доступный по адресу http://localhost/docs
• через админ панель по адресу http://localhost/admin

Техническая документация:

• Swagger доступен по адресу http://localhost/docs
• Redoc доступен по адресу http://localhost/redoc

2. Остановить docker и удалить контейнеры можно командой из корневой директории проекта:

docker compose -f docker/docker-compose.yml --env-file .env down

Если также необходимо удалить том базы данных:

docker compose -f docker/docker-compose.yml --env-file .env down -v

⬆️Оглавление

Удаление приложения:

Из корневой директории проекта выполните команду:

cd .. && rm -fr hrspace-request-builder-backend

⬆️Оглавление

Авторы:

• Aleksei Proskuriakov
• Bair Erendzhenov
• Stanislav Zatushevskii

⬆️В начало