Skip to content

yevheniikulisidi/vl34-11-bot

Repository files navigation

Telegram bot for Vinnytsia Lyceum No. 34 🤖

This bot is designed for eleventh-grade students to prevent inconveniences and frequent problems with the unavailability of the electronic journal "New Knowledge."

Main functions of the bot:

  • Quick and convenient access to the schedule: Instant access to the current schedule of classes.
  • One-click connection to online lessons: Ability to join online lessons directly from the schedule.
  • Instant notifications of schedule changes: Prompt notification of any changes to the schedule.
  • Daily lesson schedule at 7:30: Automatic sending of the daily lesson schedule every day at 7:30 in the morning.

This bot provides convenient and reliable access to the schedule, helping students efficiently plan their study day and promptly respond to changes.

Bot screenshot

Statistics

The bot has been running since 2024 and has been in operation for more than 5 months.

Photos

Active Users Lesson Connections
Preventing Unavailability Received Schedules

Installation

Prerequisites

To run this bot, you need to have Docker installed. You can download Docker from the official website.

Instructions

  1. Clone the repository:

    git clone https://github.com/yevheniikulisidi/vl34-11-bot.git
    cd vl34-11-bot
  2. Install dependencies:

    npm install
  3. Configure the environment:

    • Copy the .env.example file to .env:
    cp .env.example .env
    • Fill in the environment variables in the .env file (note that without student credentials, the bot will not be able to function properly).

Usage

  1. Run Docker containers in detached mode:

    docker-compose up -d
  2. Run in development mode:

    npm run start
  3. Run in watch mode:

    npm run start:dev
  4. Run in production mode:

    npm run start:prod

After completing these steps, the bot will be ready to work and respond to commands from users.