Чат-бот для “Новогоднего адвента по цифровой гигиене «Кибербезопасный Новый год”

Добро пожаловать в телеграм-бот для кибер-гигены, выполняй рекомендации и обучайся!

Попробуй прямо сейчас: 🤖https://t.me/CyberItCubeBot

Разработчики

IT-куб Новосибирская классическая гимназия №17, команда “IT Developer” в составе:

• Мария Евстратова
• Екатерина Гельбер
• Артемий Зотов
• Эльдар Амрулин

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

Для запуска и работы требуется:

• Python версии 9 или 10 (на более поздних версиях не тестировалось).
• Установить перечень зависимостей из requirements.txt.

На ваше усмотрение вы можете использовать системный интерпритатор или виртуальное окружение - venv, мы рекомендуем использовать venv внутри проекта, чтобы избежать конфликта версий с другими проектами.

Инструкция по установке и запуску

Для запуска своего бота выполните следующие шаги:

1. Установите Python версии 9 или 10.
2. Создайте и активировать venv внутри проекта с помощью IDE или с помощью команды python -m venv /path/to/new/virtual/environment или воспользуйтесь документацией https://docs.python.org/3.10/library/venv.html.
3. Зарегистрируйте свой бот в BotFather и получите bot-token.
4. Задайте конфигурация приложения с помощью переменных окружения:
   • PORT - порт для WEB-сервера, по умолчанию 5000.
   • SECRET_KEY - секретный ключ для шифрования паролей при авторизации, по умолчанию, changeit.
   • API_BOT_TOKEN - значение bot-token.
   • BOT_NAME - наименование вашего бота, которое вы задали ему при регистрации.
   • DB_URL - полный URL для доступа к БД, включающий адрес, название БД, логин и пароль.
5. Перейдите на ветку main.
6. Выполните установку зависимостей командой: pip install -r requirements.txt
7. Выполните запуск бота командой: python main.py.

Запуск с умолчательной конфигурацией

Для разработки и тестирования предусмотрена ветка develop, в которой уже задан тестовый API_BOT_TOKEN, если вы хотите проверить функциональность без регистрации своего бота, то перейдите на ветку develop и выполните запуск бота python main.py.

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

Для API предусмотрена документация в виде Swagger и доступна по адресу: http://localhost:5000/apidocs

Запущенный экземпляр бота в облаке

Воспользуйтесь нашим ботом: 🤖https://t.me/CyberItCubeBot

Мы развернули бот на бесплатных платформах:

• в качестве БД был использован Postgres на ресурсе: https://supabase.com/;
• в качестве хостинга приложения был использован ресурс: https://dashboard.render.com/;
• для имитации активности был использован ресурс https://cron-job.org/.

📋 Состояние запущенного бота | ⏰ Разбудить бот | 🗂️ База данных | 🐱 Проект на Github

Внимание! Т.к. все эти платформы бесплатные, то бот может приостанавливаться по различным причинам, если бот по ссылке вам не отвечает, то обратитесь к разработчикам для того, чтобы его “разбудить”.