Skip to content

Jlychee/OrgaBot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

95 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🤖 Event Organizer Bot

Event Organizer Bot — это телеграм-бот для автоматизации мероприятий.
Он помогает организаторам и участникам управлять событиями, получать уведомления, регистрироваться на мастер-классы и оставаться на связи — прямо через Telegram.


📋 Оглавление


Бот ориентирован на три основные группы пользователей:

  • 👤 Участники (студенты, сотрудники, гости)
  • 🛠 Организаторы мероприятий
  • 🤝 Волонтёры и помощники

📌 Возможности

👥 Для участников:

  • 🎟 Регистрация на мероприятия и мастер-классы
  • 🧾 Просмотр личного расписания
  • 🔔 Уведомления об изменениях и напоминания
  • 💬 Чат с организаторами и другими участниками
  • 📚 Доступ к актуальной информации

🧑‍💼 Для организаторов:

  • 🗂 Управление мероприятиями и расписанием
  • 👥 Управление списками участников
  • 📢 Массовая рассылка уведомлений
  • 📊 Статистика посещаемости и активности

🛠️ Технологии

Проект разработан с использованием:


⚙️ Установка и запуск

🔻 Клонирование проекта

git clone https://github.com/Jlychee/OrgaBot

🧰 Создание виртуального окружения

Windows
python -m venv .venv
.venv\Scripts\activate
Linux / MacOS
python3 -m venv .venv
source .venv/bin/activate

📦 Установка зависимостей

pip install -r requirements.txt

🔐 Настройка переменных окружения

Создайте .env файл в корне и укажите в нём:

BOT_TOKEN=ваш_токен_бота

▶️ Запуск

python main.py

Бот начнёт работать и будет доступен в Telegram.


🔐 Безопасность

  • 🔑 Система авторизации по ролям (участник / организатор)
  • 🧩 Проверка прав на админ-действия
  • 🛡 Работа с персональными данными через .env и безопасные методы

📎 Структура проекта

Naumen_bot/
├── src/             # Основная логика бота
├── utilities/       # Вспомогательные модули
├── main.py          # Точка входа
├── requirements.txt # Зависимости
└── .env             # Настройки окружения (в .gitignore)

Чек-лист

- [ x ] Добавлен `.gitignore`. Убедитесь, что там есть `.venv` и `.idea`
- [ x ] Создано виртуальное окружение
- [ x ] Есть файл `requirements.txt` или `pyproject.toml`. Исключения: если у вас нет внешних зависимостей.
- [ +- ] Настроены линтеры: `mypy` и `flake8`
- [ x ] Настроены форматтеры: `isort` и `black`
- [ x ] Написаны тесты
- [ x ] Написана документация к каждому методу, классу и функции
- [ x ] Написан красивый `README.md` (для форматирования можно использовать markdown), где есть информация о том, как проект установить и запустить, что он делает  и умеет, какие фунции там есть
- [ ] (Для консольных утилит) написан help
- [ ] (Опционально) Есть прекоммит

About

Telegram-бот для автоматизации мероприятий: помогает участникам регистрироваться на события и мастер-классы, получать уведомления и смотреть расписание, а организаторам — управлять мероприятиями, списками участников и рассылками

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages