Skip to content

Latest commit

 

History

History
101 lines (63 loc) · 5.52 KB

README.md

File metadata and controls

101 lines (63 loc) · 5.52 KB
Raw

T-Schedule Bot

T-Schedule Bot - это Telegram-бот, разработанный для переноса расписания с edu.donstu.ru в Google Calendar. Данный бот автоматизирует процесс управления расписанием и помогает студентам быть в курсе своих учебных занятий.

Описание проекта

T-Schedule Bot предоставляет следующие ключевые функции:

  • Перенос расписания с edu.donstu.ru в Google Calendar.
  • Возможность настройки цветовых меток для разных видов занятий.
  • Ручная установка и обновление ID студента.
  • Автоматическое обновление расписания каждые 15 минут в учебное время.

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

Команда /start

Команда /start запускает бота и отправляет ссылку на ваш календарь (если такой есть).

Команда /auth

Команда /auth необходима для авторизации в боте. Следуйте инструкциям для входа в ваш аккаунт на edu.donstu.ru.

Команда /student

Команда /student позволяет вручную установить ID студента для получения расписания.

Команда /colorize

Команда /colorize позволяет настроить цветовые метки для занятий в вашем календаре.

Поддерживаемые платформы

T-Schedule Bot поддерживает Telegram как платформу для взаимодействия. Вы можете добавить бота к себе в Telegram и начать использовать его.

Тестирование и разработка

Следующие инструкции помогут запустить бота на вашем локальном компьютере для разработки и тестирования.

Предварительные условия

Для установки и использования бота вам понадобятся:

Установка

  1. Скопируйте репозиторий с ботом:
git clone https://github.com/lentryd/t-schedule.git
cd t-schedule
  1. Установите зависимости с помощью npm:
npm i
  1. Создайте файл .env в корне проекта и добавьте в него следующие переменные:
BOT_TOKEN=ваш_токен_бота
  1. Создайте проект в Google Cloud Platform
  2. Подключите Google Calendar API
  3. Подключите Google Cloud Firestore API
  4. Создайте Service Account
  5. Выберите свою учетную запись службы
  6. Нажмите «Ключи» > «Добавить ключ» > «Создать новый ключ»
  7. Выберите JSON , затем нажмите «Создать»
    Ваша новая пара открытого/закрытого ключей генерируется и загружается на ваш компьютер в виде нового файла. Сохраните загруженный файл JSON как credentials.json в своем рабочем каталоге.
  8. Запустите бота:
npm run start

Зависимости

  • dotenv - Модуль с нулевой зависимостью, который загружает переменные окружения из файла .env в process.env
  • telegraf - Современный фреймворк Telegram Bot API для Node.js
  • node-fetch - Fetch API в Node.js
  • @googleapis/calendar - API Google Calendar позволяет вам управлять своими календарями и событиями
  • @google-cloud/firestore - Node.js Серверный SDK для Google Cloud Firestore

Управление версиями

Версии проекта управляются согласно SemVer. Список доступных версий можно найти в разделе теги.

Авторы

Также посмотрите список участников, которые внесли свой вклад в проект.

Лицензия

Этот проект распространяется под лицензией MIT. Подробную информацию смотрите в файле LICENSE.