Skip to content

Latest commit

 

History

History
47 lines (35 loc) · 2.17 KB

README.md

File metadata and controls

47 lines (35 loc) · 2.17 KB
Raw

BFH Banner

myVaccinator

myVaccinator is a discord bot that alerts you about the available vaccination slots in your area every hour. Simply type !vaccine in a common server and get your vaccination slot the smart way.

Team members

  1. Nikhil Jose
  2. Midhun Mathew

Team Id

BFH/receEVi8kY4wfVJJy/2021

Link to product walkthrough

https://vimeo.com/554606989

How it Works ?

When you type !vaccine, required details are collected conversationaly by the bot. It then stores this data to a mongoDB database and and sends you alerts on regular intervals as DM in discord. Vaccination slot details are fetched using the CoWin API. In order to overcome the rate limtations of the API the server caches the slot availability data every 10 minutes so that the API limit will never be exhausted.

myvac-demo.mp4

Bot Commands

Bot Commands

Sample Conversations

Sample Conversation

Packages used

axios - v0.21.1
body-parser - v1.19.0
discord.js - v12.5.3
dotenv -v9.0.2
mongoose - v5.12.10
node-cron - v3.0.0

How to configure

In order to run the bot on your own Server and Database,

  • Clone the repo
  • cd into the repo folder
  • Add a .env file with valid bot token and mongoDB connection string in the format specified in .env.example
  • Run the app using node bot.js
    • In order for the CoWin API to work properly, the bot should be hosted in a server located in India.
    • It works perfectly on AWS EC2 t2.micro instances hosted in Mumbai(Free tier eligible)

How to Use

In a common server type !vaccine in a channel to invoke the bot and start recieving alerts.
Type !help in a channel to find all the available commands.