https://github.com/euberdeveloper/tumi-app-bot
A telegram bot to receive a message when there is a new spot for tumi events
https://github.com/euberdeveloper/tumi-app-bot
telegram-bot tum typescript
Last synced: 28 days ago
JSON representation
A telegram bot to receive a message when there is a new spot for tumi events
- Host: GitHub
- URL: https://github.com/euberdeveloper/tumi-app-bot
- Owner: euberdeveloper
- License: mit
- Created: 2021-10-11T14:25:12.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-19T08:55:09.000Z (over 1 year ago)
- Last Synced: 2025-02-04T15:50:02.409Z (3 months ago)
- Topics: telegram-bot, tum, typescript
- Language: TypeScript
- Homepage: https://t.me/tumi_app_bot
- Size: 350 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [tumi-app-bot](https://t.me/tumi_app_bot)
A telegram bot to receive a message when there is a new spot for tumi events
TODO:
* Make bot register yourself for events you want, sending notification to complete payment in case it is needed
## Project purpose
At TUM we are in about **50 000** students and a great quantity are exchange or international students. The [TUMI App](https://tumi.esn.world/events) is a pwa where students can register to events organized for international students, but there are usually **few spots available**. Events with even 300 spots can become fully booked in less than 10 minutes. This project consists in a **telegram bot** that **sends you a message** when a new event is published or when there is a new free spot in an event that was fully booked.
## How was it made
The bot has been developed by using **Typescript** and **Node.js**. Initially, it used a **webscraper** that used **puppeteer**; it worked but it was susceptible to the websites' changes and was not so performant. This is why a newer version was developerd that used directly the **GraphQL** api used by the tumi pwa. **Redis** has been used as database, **Telegraf** as bot library and **Bull.js** as a scheduler. The deploy has been done with **Docker** (swarms). The code is also linted with **ESLint** and **Prettier**.
## How does it work
It is quite simple:
1. The **telegram bot** is started; it has the **/start**, **/stop**, **/help**, **/author** and **/version** commands.
2. A **scheduler** is started by using bull.js
3. Every time the scheduler fires, it **gets the updated events**, **saves them on redis**, **checks if there are changes** (new event id, change of an event's spots from 0 to a positive number, an event registration is now open or opens soon) and, if there are changes, **sends a telegram message** to all the registered users.
4. Every time a user **starts or stops** the bot, it is **added or removed** to the redis database, so that the bot knows to whom send the messages.
## How was it deployed
There is a **Dockerfile** that is used to create an **image** of the bot, that is automatically published on **DockerHub** through a **Github Action**. In the `deploy` folder, there is the `docker-compose.yml` file that is used by **docker swarm** to serve the bot, the redis db and the **watchtower updater**.