Посмотреть проект можно по ссылке
- О проекте
- Авторы проекта
- Стек технологий
- Функционал
- Установка зависимостей
- Запуск
- Наполнение БД
- Telegram бот
MVP CRM-системы для Амбассадоров Яндекс Практикума.
Команда:
-
Product manager
- Смирнов Алексей
-
Project manager
- Кравцова Елена
-
Business analytics
- Филимонова Ольга
- Кашина Елена
-
System analytics
- Карпетис Александр
- Гогорян Даниил
- Ольховская Елена
-
Designers
- Каравашкина Александра
- Каткова Анастасия
- Храковская Ирина
- Теплова Полина
-
Frontend
-
Backend
- Реализован базовый функционал CRM приложения.
- Настроена интеграция с Яндекс Forms.
- Настроена интеграция с Яндекс ID.
- Подключен прототип telegram бота.
- Реализована рассылка через email и telegram.
- Создайте и перейдите в директорию проекта:
mkdir forms
cd forms/-
Скачайте и добавьте файл docker-compose.production.yml в директорию.
-
Cоздайте файл .env:
nano .envДобавьте следующие строки и подставьте свои значения:
# postgres
POSTGRES_DB=DB # название db
POSTGRES_USER=USER # имя пользователя для db
POSTGRES_PASSWORD=PASSWORD # пароль пользователя для db
DB_HOST=db # если поменять, то тогда нужно поменять название сервиса в docker-compose.production.yml
DB_PORT=5432 # это порт для доступа к db
# django
SECRET_KEY=SECRET_KEY # SECRET_KEY в настройках django
DEBUG=False # режим debug (True или False)
ALLOWED_HOSTS=127.0.0.1 backend # ваши адреса через пробел (пример:localhost 127.0.0.1 xxxx.com)
# certbot
GET_CERTS=False # True для получения сертификатов (обязательно укажите email в CERTBOT_EMAIL
CERTBOT_EMAIL=[email protected] # Email для регистрации certbot
DOMAIN=exemple.com # Домен на котором вы разворачиваете
# tg bot
BOT_TOKEN=telegram_bot_token # Токен телеграм бота, если вы планируете его использовать
# yandex ID
YANDEX_ID_CLIENT_SECRET=secret # Client secret в приложении yandex ID
# mail
USE_SMTP=False # использовать ли настоящий сервис по отправке почты, иначе сообщения будут сохранятся внутри контейнера (папка sent_emails)
EMAIL_HOST=EMAIL_HOST # домен вашего email service
EMAIL_PORT=EMAIL_PORT # порт для подключения к серверу почты
EMAIL_HOST_USER=EMAIL_HOST_USER # email с которого будет осуществлятся рассылка
EMAIL_HOST_PASSWORD=EMAIL_HOST_PASSWORD # пароль для доступа со стороны стороннего приложения
EMAIL_USE_TLS=False # использовать TLS (True или False)
EMAIL_USE_SSL=True # использовать SSL (True или False)
# frontend
VITE_REACT_APP_BASE_URL='https://youradress.com' # url для API запросов (можно не указывать, если используете docker-compose.production.yml)
VITE_REACT_APP_CLIENT_ID='ClientID' # идентификатор приложения для получения OAuth токена
VITE_REACT_APP_CURRENT_URL='https://youradress.com' # url для приложения яндекс IDВ терминале linux это можно сделать так:
sudo apt update
sudo apt install curl
curl -fSL https://get.docker.com -o get-docker.sh
sudo sh ./get-docker.sh
sudo apt install docker-compose-plugin- Запустите контейнеры с проектом следующей командой (используйте флаг -d для запуска в фоновом режиме):
docker compose -f docker-compose.production.yml upВ терминале Linux могут потребоваться права суперпользователя:
sudo docker compose -f docker-compose.production.yml up- Для доступа в админ-зону:
Логин: [email protected]
Пароль: admin
Для импорта начальных данных воспользуйтесь командой:
docker compose exec backend python manage.py xml_importПосле запуска проект можно будет посмотреть по ссылке.
Посмотреть документацию: Swagger
Реализован небольшой функционал чат бота. Добавлено веб приложение для бота.
Для прослушивания уведомлений от telegram api используется webhook.
Чтобы установить вебхук для вашего домена воспользуетесь следующей командой:
docker compose exec backend python manage.py telegram_webhook -s