58 lines
3.3 KiB
Markdown
58 lines
3.3 KiB
Markdown
# Название проекта: db_timetable
|
|
|
|
## Описание
|
|
db_timetable - это удобное решение для студентов и преподавателей, позволяющее получать актуальное расписание занятий на сегодня, завтра и послезавтра. Проект предлагает функционал выбора группы, настройки уведомлений о предстоящих занятиях и автоматическое переключение на резервное расписание в случае недоступности основного источника данных.
|
|
|
|
## Функциональность
|
|
- Выбор группы: Пользователи могут выбрать свою учебную группу для получения персонализированного расписания.
|
|
- Уведомления: Возможность настройки времени получения уведомлений о предстоящих занятиях.
|
|
- Резервное расписание: В случае недоступности основного источника данных, система автоматически переключается на резервное расписание.
|
|
|
|
## Технологии и зависимости
|
|
Проект разработан с использованием следующих технологий:
|
|
- docker
|
|
- python
|
|
- aiogram
|
|
- BeautifulSoup
|
|
- requests
|
|
- pymongo
|
|
|
|
# Для запуска проекта необходимо выполнить следующие шаги:
|
|
Основное:
|
|
- создайте .env файл
|
|
- напишите в нём TOKEN=токен телеграм бота
|
|
|
|
Для продакшн версии:
|
|
```bash
|
|
docker-compose -f docker-compose-prod.yml up -d
|
|
```
|
|
|
|
Для разработки:
|
|
```bash
|
|
poetry install
|
|
docker-compose up -d
|
|
poetry run python main.py
|
|
```
|
|
|
|
###### Примечание: В режиме разработки поднимается только база данных.
|
|
|
|
## Использование
|
|
Для получения расписания выполните следующие команды:
|
|
- На сегодня: /today или просто "сегодня"
|
|
- На завтра: /tomorrow или просто "завтра"
|
|
- На послезавтра: /the_day_after_tomorrow или просто "послезавтра"
|
|
|
|
## Конфигурация уведомлений
|
|
Для настройки времени уведомлений используйте команду: /on_notification
|
|
|
|
|
|
## Резервное расписание
|
|
Резервное расписание активируется автоматически при недоступности основного источника. Обновление резервного расписания происходит автоматически.
|
|
|
|
## Вопросы и ответы (FAQ)
|
|
- Заглушка для часто задаваемых вопросов
|
|
|
|
## Контакты для связи и поддержки
|
|
Если у вас возникнут вопросы или предложения, пожалуйста, свяжитесь со мной:
|
|
- Telegram: https://t.me/Dmitrium12
|