Социальная сеть для обмена фотографиями любимых питомцев с API

Деплой проекта Kittygram в Docker контейнерах и CI/CD с помощью GitHub Actions на удалённый сервер

Описание проекта

Проект Kittygram - социальная сеть для обмена фотографиями любимых питомцев, а именно котов и кошек, с возможностью публикации их достижений.

Это полностью рабочий проект, который состоит из бэкенд-приложения на Django и фронтенд-приложения на React.

Возможности проекта:

Можно зарегистрироваться и авторизоваться, добавить нового котика на сайт или изменить существующего, добавить или изменить достижения, а также просмотреть записи других пользователей.

API для kittygram написан с использованием библиотеки Django REST Framework, используется TokenAuthentication для аутентификации, а также подключена библиотека Djoser.

Проект размещён в нескольких Docker контейнерах. В контейнере бэкенда настроен WSGI-сервер Gunicorn. Автоматизация тестирования и деплоя проекта Kittygram осуществлена с помощью GitHub Actions.

Настройка CI/CD

Деплой проекта на удалённый сервер настроен через CI/CD с помощью GitHub Actions, для этого создан workflow, в котором:

• проверяется код бэкенда в репозитории на соответствие PEP8;
• настроено автоматическое тестирование фронтенда и бэкенда;
• в случае успешного прохождения тестов образы должны обновляться на Docker Hub;
• обновляются образы на сервере и перезапускается приложение при помощи Docker Compose;
• выполняются команды для сборки статики в приложении бэкенда, переноса статики в volume; выполняются миграции;
• происходит уведомление в Telegram об успешном завершении деплоя.

Пример данного workflow сохранен в файле kittygram_workflow.yml в корневой директории проекта, при необходимости запуска перепишите содержимое файла в .github/workflows/main.yml.

Сохраните следующие переменные с необходимыми значениями в секретах GitHub Actions:

DOCKER_USERNAME - логин в Docker Hub
DOCKER_PASSWORD - пароль для Docker Hub
SSH_KEY - закрытый SSH-ключ для доступа к продакшен-серверу
SSH_PASSPHRASE - passphrase для этого ключа
USER - username для доступа к продакшен-серверу
HOST - адрес хоста для доступа к продакшен-серверу
TELEGRAM_TO - ID своего телеграм-аккаунта
TELEGRAM_TOKEN - токен Telegram-бота

Файл docker-compose.yml для локального запуска проекта и файл docker-compose.production.yml для запуска проекта на облачном сервере находятся в корневой директории проекта.

Технологии

• Python 3.9
• Django 3.2.3
• Django REST framework 3.12.4
• PostgreSQL
• Docker
• Nginx
• Gunicorn
• GitHub Actions

Запуск проекта в dev-режиме

Клонировать репозиторий и перейти в него в командной строке:

git clone git@github.com:miscanth/kittygram_final.git

Cоздать и активировать виртуальное окружение:

python3.9 -m venv venv 

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

  source venv/bin/activate
  

• Если у вас windows

  source venv/scripts/activate
  

python3.9 -m pip install --upgrade pip

Установить зависимости из файла requirements.txt:

pip install -r requirements.txt

Задайте учётные данные БД в .env файле, используя .env.example:

POSTGRES_USER=логин
POSTGRES_PASSWORD=пароль
POSTGRES_DB=название БД
DB_HOST=название хоста
DB_PORT=5432
SECRET_KEY=django_settings_secret_key
ALLOWED_HOSTS=127.0.0.1, localhost

Запустить Docker Compose с дефолтной конфигурацией (docker-compose.yml):

• Выполнить сборку контейнеров: sudo docker compose up -d --build

• Применить миграции: sudo docker compose exec backend python manage.py migrate

• Создать суперпользователя: sudo docker compose exec backend python manage.py createsuperuser

• Собрать файлы статики: sudo docker compose exec backend python manage.py collectstatic

• Скопировать файлы статики в /backend_static/static/ backend-контейнера: sudo docker compose exec backend cp -r /app/collected_static/. /backend_static/static/

• Перейти по адресу 127.0.0.1:8000

Примеры запросов:

Пример GET-запроса с токеном пользователя adminka23: Просмотр списка достижений. GET .../api/achievements/ Пример ответа:

[
    {
        "id": 1,
        "achievement_name": "милая мордашка"
    },
    {
        "id": 2,
        "achievement_name": "главный враг новогодней ёлки"
    }
]

Пример POST-запроса с токеном пользователя adminka23: добавление нового котика. POST .../api/cats/

{
    "name": "Alex",
    "color": "#FF8C00",
    "birth_year": 2010
}

Пример ответа:

{
    "id": 12,
    "name": "Alex",
    "color": "darkorange",
    "birth_year": 2010,
    "achievements": [],
    "owner": 3,
    "age": 14,
    "image": null
}