Hake Shonassy Bot

https://t.me/HakeShonassyBot

Телеграм бот, собирает статистики чата для развлечения, присваивает ачивки участникам.

Разработка

Хочешь принять участие в разработке? Узнай как.

Запуск бота для тестов

1. Зарегистрируй себе тестового бота. Напиши BotFather /start, затем /newbot и следуй инструкциям.
2. BotFather даст тебе токен похожий на этот 123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11.
3. Добавь этот токен в переменную TELEGRAM_BOT_TOKEN в файле .env.

echo "TELEGRAM_BOT_TOKEN=123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11" > .env

4. Запуск бота.

make up

5. При первом запуске бота необходимо установить зависимости и запустить миграции.

make setup

5. Можешь писать своему боту в личку или создать себе тестовую группу и добавить его туда.
6. Чтобы бот правильно работал когда добавлен в группу, ему нужно выключить Privacy mode это можно сделать в настройках бота у BotFather @tvoy_bot > Bot settings > Group privacy > Turn off. В списке юзеров группы, рядом с юзернэймом бота появится has access to messages

Получить домен для разработки

Чтобы телеграм логин виджет на главной странице заработал, требуется привязать домен к своему тестовому боту.

1. Добавить имя бота в файл .env под ключ BOT_NAME, так приложение будет знать какой бот будет логинить юзеров.

   echo "BOT_NAME=haketestkirill_bot" >> .env

2. Определить домен: выполни

   make show_local_development_url
   # команда вернет url вроде этого 
   # https://haketestkirillbot.loca.lt

3. Привязать домен к боту: напиши BotFather команду /setdomain и следуя инструкциям передай ему свой url.

Если все сделано верно и домен уникальный, после запуска (make dev), приложение будет доступно в браузере по твоему домену и логин виджет будет работать.

Запуск автотестов

make setup_test
make test

Релиз

Инструкция для мэйнтейнеров

1. Записать свой пароль от DockerHub в файл docker_password.txt в корень проекта
2. Выполнить make docker-login
3. Выполнить make docker-release-latest (остальные задачи релиза см. Makefile)

Приватность данных

Бот хранит все сообщения, к которым имеет доступ (Телеграм юзернэйм, имя, фамилия указанные в телеграме, текст и время сообщения, в том числе). Бот реализован в развлекательных и образовательных целях, хранимые данные используются только для составления статистики, тем не менее авторы отказываются от ответственности за сохранность данных. Используйте на свой страх и риск.