REST API для системы сервиса рассылок уведомлений

Функциональные требования

Ссылка на техническое задание

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

Проект состоит из проектируемого API сервиса для работы с данными клиентов и управления рассылками сообщений.

API сервис реализуется на базе фреймворка DRF.

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

Python 3.6+
Docker
Works on Linux, Windows, macOS, BS

Стек технологий

Python 3.8
Django 3.1
Django Rest Framework
PostreSQL
Nginx
gunicorn
Docker
Сelery
Redis

Установка проекта из репозитория (Linux и macOS)

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

git clone git@github.com:NikitaChalykh/API_Mailings_TW.git

cd API_Mailings_TW

Cоздать и открыть файл .env с переменными окружения:

cd infra

touch .env

Заполнить .env файл с переменными окружения по примеру:

echo DB_ENGINE=django.db.backends.postgresql >> .env

echo DB_NAME=postgres >> .env

echo POSTGRES_PASSWORD=postgres >> .env

echo POSTGRES_USER=postgres >> .env

echo DB_HOST=db >> .env

echo DB_PORT=5432 >> .env

echo BROKER=redis://redis >> .env

echo BROKER_URL=redis://redis:6379/0 >> .env

Токен для сервиса отправки сообщений согласно ТЗ

echo SENDING_API_TOKEN=****************** >> .env

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

docker-compose up -d

Запуск миграций и сбор статики:

docker-compose exec web python manage.py migrate

docker-compose exec web python manage.py collectstatic --no-input

Документация к проекту

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

http://127.0.0.1/redoc/

http://127.0.0.1/swagger/