Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Flexlug/MiigaikVkBot
Bot for retrieving university timetable
https://github.com/Flexlug/MiigaikVkBot
bot csharp miigaik vk
Last synced: 20 days ago
JSON representation
Bot for retrieving university timetable
- Host: GitHub
- URL: https://github.com/Flexlug/MiigaikVkBot
- Owner: Flexlug
- Created: 2022-04-09T15:54:15.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-09-09T22:40:52.000Z (about 1 year ago)
- Last Synced: 2024-07-30T21:00:07.038Z (4 months ago)
- Topics: bot, csharp, miigaik, vk
- Language: C#
- Homepage:
- Size: 135 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MiigaikVkBot
[![ci](https://github.com/Flexlug/MiigaikVkBot/actions/workflows/publish.yml/badge.svg)](https://github.com/Flexlug/MiigaikVkBot/actions/workflows/publish.yml)
Бот, предназначенный для автоматического получения расписания с университетского сайта https://study.miigaik.ru/.
## Требования
Необходимо получить следующие вещи:
1. Создать группу в VK и узнать её ID
2. В настройках группы в разделе "Ключи доступа" получить ключ";
3. Узнать URL вашей группы. Его можно найти [здесь](https://study.miigaik.ru/api/v1/groups).Для запуска требуется Docker.
## Сборка исходников и запуск
1. Клонируем репозиторий
```bash
git clone https://github.com/Flexlug/MiigaikVkBot.git
cd MiigaikVkBot
```2. Редактируем `docker-compose.yml`, где указываем ключ доступа, ID группы и URL группы
```yml
version: '3.8'services:
miigaikvkbot:
build:
context: .
restart: unless-stopped
environment:
"VK_TOKEN": "PASTE_YOUR_TOKEN_HERE"
"VK_GROUP_ID": PASTE_YOUR_GROUP_ID_HERE_IN_ULONG_FORMAT
"GROUP_URL": "PASTE_YOUR_GROUP_URL_HERE"
```3. Запускаем бота
```bash
docker compose up -d --build
```Если все было сделано правильно - бот заработает. Получить к нему доступ можно через ЛС группы.
![demo](https://github.com/Flexlug/MiigaikVkBot/raw/master/docs/demo.png)