EdGame_bot

Телеграм бот для геймификации образовательного процесса для детей 13-18 лет в лагере.

Установка на сервер

1. На сервере создайте .env файл и заполните по образцу .env.example.

   touch .env

2. Скопируйте docker-compose.deploy_stage.yaml и запустите его:

   docker compose --f docker-compose.deploy_stage.yaml up -d

На сервере должен быть установлен docker compose

---

Использование

При регистрации пользователя, на этапе когда просят ввести пароль:

• student для получения роли студента
• counsellor для получения роли вожатого
• methodist для получения роли методиста
• imaking для получения роли админа

Роль суперпользователя

• Поменять в .env BOSS_ID на свой
• Перезапустить бота
• Появится возможность менять мастер-пароль и пароли для вожатого и методиста

---

Разработка

1. Клонировать репозиторий.

   git clone https://github.com/Studio-Yandex-Practicum/EdGame_bot.git
   cd EdGame_bot

2. Создать и активировать виртуальное окружение.

   python -m venv venv
   source venv/bin/activate

3. Установите зависимости

   pip install -r requirements.txt

4. Создайте .env файл и заполните по образцу .env.example.
5. Запустить базу данных:

   docker compose --f docker-compose.dev.yml up -d

6. Применяем миграции

   alembic upgrade head

7. Включить pre-commit

   pre-commit install

8. Заполняем тестовыми данными

   python create_test_data.py

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

• Перейти в папку docs
• Запустите:

sphinx-apidoc -o ./source ..

• Запустите

make html

• Документация находиться в папке docs/build/html