maks-oleksyuk / vnu-rozklad-bot

🤖 Telegram bot is designed to show the university schedule with a user-friendly interface and the use of third-party API.

Telegram Bot to show university schedule

This is a Telegram bot for showing the university schedule, with a user-friendly interface and the use of third-party APIs (© ПП Політек-софт).

Instructions for launching the bot

To run the bot, you need to install dependencies and configure some environment variables. Below are instructions on how to do this:

1. Clone the repository to your local computer:

   git clone https://github.com/maks-oleksyuk/VNU-Rozklad-bot.git

2. Create an .env file in the root directory of the project and fill it according to the example specified in the .env.example file

   TOKEN=your_bot_token
   ADMIN_ID=1234567
   API_IP=0.0.0.0
   # and other, see .env.example

3. If all the variables are configured correctly, you can run the bot on Docker. To do this, you can execute the following commands.

   make up

4. Import mariadb database. In order to import an existing database, you can place the .sql file in the ./db-init folder for automatic import when the container is started

5. More detailed information can be obtained with the following command:

   make help

Commands

This Telegram bot has the following commands:

• start - 🚀 Start the bot
• now - 🔆 Current pair
• today - ⬇️ Schedule for today
• tomorrow - ⤵️ Schedule for tomorrow
• week - ⏬ Schedule for the week
• nextweek - ⏩ Schedule for next week
• rooms - 🚪Search for free audiences
• set_date - 📆 Schedule for the entered date
• about - ℹ️ About the bot
• help - ❔ Help
• cancel - 🆑 Cancel action | Change request