Проект Запущен на Этом IP: 130.193.52.139
- tests - Проверка кода на соответствие стандарту PEP8 (с помощью пакета flake8) и запуск pytest. Дальнейшие шаги выполнятся только если push был в ветку master или main.
- build_and_push_to_docker_hub - Сборка и доставка докер-образов на Docker Hub
- deploy - Автоматический деплой проекта на боевой сервер. Выполняется копирование файлов из репозитория на сервер:
- send_message - Отправка уведомления в Telegram
Создайте и активируйте виртуальное окружение, обновите pip:
python3 -m venv venv
. venv/bin/activate
python3 -m pip install --upgrade pip
Запустите автотесты:
pytest
Отредактируйте файл nginx/default.conf
и в строке server_name
впишите IP виртуальной машины (сервера).
Скопируйте подготовленные файлы docker-compose.yaml
и nginx/default.conf
из вашего проекта на сервер:
scp docker-compose.yaml <username>@<host>/home/<username>/docker-compose.yaml
sudo mkdir nginx
scp default.conf <username>@<host>/home/<username>/nginx/default.conf
В репозитории на Гитхабе добавьте данные в Settings - Secrets - Actions secrets
:
DOCKER_USERNAME - имя пользователя в DockerHub
DOCKER_PASSWORD - пароль пользователя в DockerHub
HOST - ip-адрес сервера
USER - пользователь
SSH_KEY - приватный ssh-ключ (публичный должен быть на сервере)
PASSPHRASE - кодовая фраза для ssh-ключа
DB_ENGINE - django.db.backends.postgresql
DB_HOST - db
DB_PORT - 5432
TELEGRAM_TO - id своего телеграм-аккаунта (можно узнать у @userinfobot, команда /start)
TELEGRAM_TOKEN - токен бота (получить токен можно у @BotFather, /token, имя бота)
DB_NAME - postgres (по умолчанию)
POSTGRES_USER - postgres (по умолчанию)
POSTGRES_PASSWORD - postgres (по умолчанию)
Установите Docker и Docker-compose:
sudo apt install docker.io
sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
Проверьте корректность установки Docker-compose:
sudo docker-compose --version
Соберите статические файлы (статику):
docker-compose exec web python manage.py collectstatic --no-input
Примените миграции:
docker-compose exec web python manage.py makemigrations
docker-compose exec web python manage.py migrate --noinput
Создайте суперпользователя:
docker-compose exec web python manage.py createsuperuser
или
docker-compose exec web python manage.py loaddata fixtures.json
Например, после запуска проекта можно посмотреть Документацию.
Но я приведу несколько примеров.
POST http://127.0.0.1:8000/api/v1/auth/signup/
Регистрация Пользователя
{
"username":"Fake",
"email": "[email protected]"
}
POST http://127.0.0.1:8000/api/v1/auth/token/
в бэк приходит письмо с кодом
Получение Jwt Токена
{
"username":"Fake",
"confirmation_code": "biv4hr-69c31c5b2ad53627baf8c1f5273156e3"
}
POST http://127.0.0.1:8000/api/v1/titles/1/reviews/1/comments/1/
Оставить комментарий для
произведения с id=1
ревью id=1
Коммента id=1
{
"text": "testComment"
}
POST http://127.0.0.1:8000/api/v1/auth/users/me/
в бэк приходит письмо с кодом
Получение Jwt Токена
{
"username": "Fake",
"email": "[email protected]",
"first_name": "",
"last_name": "",
"bio": "",
"role": "user"
}