hackathon_yandex_ambassadors

АПИ для приложение CRM «Амбассадоры Практикума»

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

Внутренняя CRM для «Амбассадоры Практикума» – это сервис, предназначенный для управления взаимодействием с амбассадорами «Яндекс Практикума». Фронтенд CRM взаимодействует с бэкендом через АПИ (часть бэкенда).

С помощью АПИ осуществляются:

• регистрация и авторизация пользователя;
• хранение информации о каждом амбассадоре;
• управление данными амбассадоров: добавление, редактирование и удаление информации;
• отслеживание активности амбассадоров, прохождения амбассадорами гайда и другие важные аспекты взаимодействия с амбассадорами;
• отправка амбассадорам мерча, учет полученного мерча каждым амбассадором;
• отслеживание затрат на отправку мерча для каждого амбассадора и в общем за отчетный период, учет годовых расходов как по отдельным амбассадорам, так и по всей программе в целом;
• оптимизация взаимодействия с амбассадорами через создание списка часто задаваемых вопросов;
• уведомления от CRM системы для оперативного реагирования на события и изменения.

Команда backend разработки

• AlexanderPAI - тимлид, руководство командой backend-разработки, code review, разработка эндпойнтов гайдов и контента амбассадоров (эндпойнты guide_kits, guide_tasks, guides)
• earlinn - разработка эндпойнтов мерча, заявок на мерч, промокодов амбассадоров, годового бюджета (эндпойнты merch_category, merch_price, promocodes, send_merch); настройка динамической документации апи в форматах Swagger и Redoc; деплой на сервер и настройка CI/CD; настройка интеграции с Google Sheets API
• IlyaKotenko - разработка эндпойнтов создания, редактирования, удаления и просмотра информации об амбассадорах (эндпойнты ambassadors); настройка интеграции с Яндекс Формами для регистрации новых амбассадоров
• mspitsyn - разработка эндпойнтов пользователей с авторизацией по JWT-токенам (эндпойнты auth), настройка логирования действий юзеров через LogEntry (эндпойнты edit_history)

Динамически генерируемая документация апи

Чтобы посмотреть динамическую документацию апи, нужно запустить приложение и пройти по одной из этих ссылок:

• в формате Swagger - https://hackathon-yacrm04.sytes.net/api/v1/swagger/
• в формате Redoc - https://hackathon-yacrm04.sytes.net/api/v1/redoc/

Запуск проекта на локальном компьютере (без Docker)

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

git clone git@github.com:AlexanderPAI/hackathon_yandex_ambassadors.git
cd hackathon_yandex_ambassadors

Создать в папке hackathon_yandex_ambassadors/src/config файл с названием ".env" и следующим содержанием:

SECRET_KEY=key
DOCKER=no
MODE=dev
ALLOWED_HOSTS=localhost web testserver 127.0.0.1 0.0.0.0 [::1]
CSRF_TRUSTED_ORIGINS=http://localhost/*

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

python3 -m venv env

# для Linux
source env/bin/activate

# для Windows
env\Scripts\activate
# в случае с терминалом bash эта команда может не сработать, тогда следует 
перейти в папку Scripts командой
cd env/Scripts/
# и активировать виртуальное окружение, поставив впереди точку:
. activate

# деактивировать виртуальное окружение можно командой
deactivate

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

python3 -m pip install --upgrade pip
pip install -r requirements.txt

Перейти в папку src и выполнить миграции:

cd src
python3 manage.py migrate

Собрать папку со статикой:

python3 manage.py collectstatic --no-input

Создать суперпользователя с правами администратора:

python3 manage.py createsuperuser

Локально запустить проект из папки api_final_yatube/yatube_api/:

python3 manage.py runserver

Выйти из проекта: Ctrl + C.

Запуск проекта на локальном компьютере в Docker Compose

Клонирование репозитория, создание контейнеров и первоначальная сборка

Важно: при работе в Linux или через терминал WSL2 все команды docker и docker compose нужно выполнять от имени суперпользователя — начинайте их с sudo.

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

git clone git@github.com:AlexanderPAI/hackathon_yandex_ambassadors.git
cd hackathon_yandex_ambassadors

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

Пример содержимого файла:

SECRET_KEY=key
DB_ENGINE=django.db.backends.postgresql
DB_NAME=postgres
POSTGRES_USER=postgres
POSTGRES_PASSWORD=postgres
DB_HOST=db
DB_PORT=5432
MODE=dev
DOCKER=yes
ALLOWED_HOSTS=localhost web testserver
CSRF_TRUSTED_ORIGINS=http://localhost/*

Запустить сборку контейнеров с помощью docker compose:

docker compose -f docker-compose.local.yml up -d --build

После этого будут созданы и запущены в фоновом режиме контейнеры db, backend и nginx.

Внутри контейнера backend создать админа-суперпользователя для входа в Админку:

docker compose -f docker-compose.local.yml exec -it backend python manage.py createsuperuser

После этого Админка должна стать доступна по адресу: http://localhost/admin/ API Root будет доступен по адресу: http://localhost/api/

Остановка и повторный запуск контейнеров

Для остановки работы приложения можно набрать в терминале команду Ctrl+C или открыть второй терминал и выполнить команду:

docker compose stop 

Снова запустить контейнеры без их пересборки можно командой:

docker compose start