Skip to content

Latest commit

 

History

History
82 lines (57 loc) · 5.21 KB

README.md

File metadata and controls

82 lines (57 loc) · 5.21 KB
Raw

🤖 The IPU Ranklist Telegram Bot

Open Source Love    license    contributions welcome

In very simple words, the IPU Ranklist Bot is a telegram bot that notifies you about updates on the GGSIPU website, so that you don't have to reload it a thousand times a day waiting for a result, datesheet or circular.

Click Here to instantly start using the bot.

Update: This bot is now hosted using GitHub Actions. So replies will be a bit slow. Please expect a reply to all the commands within 5-10 minutes.

screenshot     screenshot     screenshot

It's exactly what I needed. How does it work?

  • Subscribe to the datesheet/results/circulars page, depending on whichever you're expecting to be announced soon.
  • The bot will send you a message, whenever there is any update on that particular page on the website.
  • This message will contain details of all the new documents that were uploaded on the GGSIPU site, so that you can know whether or not the document you're expecting was uploaded.
  • Unsubscribe whenever you want, so that you're not bugged by all the new updates.
  • That's it.

I have telegram installed. How do I get this bot?

If you're reading this on a mobile phone, click here. Else click on the search icon on the top right corner in the Telegram app and look for "IPU Ranklist Bot".

What the hell is Telegram even? How do I get it?

To simply put, Telegram is a messaging application on steroids. If you're thinking it's like Whatsapp? Hell no. Telegram makes WhatsApp look like a bag of dried chickpeas. You can easily download the Telegram app from the App Store of your mobile device.

FEATURES

  • Check recent Results/ Datesheets/ Cirulars on the website.
  • Subscribe to the Results/ Datesheets/ Cirulars page. So you'll be notified whenever a new file is uploaded on that page.
  • Unsubscribe to stop receiving further updates.

COMMANDS

Control the IPU Ranklist Bot by sending these commands:

Command Function
/help Gets a list of commands, for when you're stuck.

Fetching last 10 uploads

Command Function
/results To fetch the last 10 results uploaded.
/datesheets To fetch the last 10 datesheets uploaded.
/circulars deprecated To fetch the last 10 circulars uploaded.

Subscribing to updates of a page.

Command Function
/subscriberesults To subscribe to result updates.
/subscribedatesheets To subscribe to datesheet updates.
/subscribecirculars deprecated To subscribe to circular updates.

Unsubscribe from updates of a page.

Command Function
/unsubscriberesults To unsubscribe from results.
/unsubscribedatesheets To unsubscribe from datesheets.
/unsubscribecirculars deprecated To unsubscribe from circulars.

TECH

It is developed in NodeJS using the awesome Telegraf and node-cron libraries. It uses MongoDB database and is live on Telegram as @ipuranklist_bot.

CONTRIBUTE

  • Raise an issue to specify what you'd like to work on. Or mention that you're working on an existing issue.
  • Fork the repository
  • Commit your code
  • Create a Pull Request

MIT Licence © Ankush Garg