Skip to content

Latest commit

 

History

History
126 lines (93 loc) · 5.51 KB

README.md

File metadata and controls

126 lines (93 loc) · 5.51 KB
Raw

VacBot(Discord CoWIN Bot)

Hey there!👋🏻, this is a Discord Bot called VacBot, which will check Covid vaccination slots availability in your area and alert you when a slot becomes available. Build by 3 students from Safi Institute of Advanced Study for TinkerHub Build From Home 2021 Discord Bot for CoWIN Project.


Add the bot to your server | Join our VacBot server


So,
1. How it Works?
2. How to Use the Bot?
3. How to Configure Project?
4. Which all Libraries used?



How does this work?

This is a discord app to get upcoming COWIN appointments based on commands. For each command you can register yourself to the database, with your District and Age, you can check the slots for vaccination using your Pincode, update your district while you moving put and a lot more. This bot works in Direct Message, but you can also add the bot to your server, and you can see a link to send Direct Message to the bot. After you register your district with the bot, you'll get the slot availability notification every day at 6:40AM(IST). Excited to check out the bot? Click here to go to 'How to use the bot.'



How to Use the Bot?

  1. Click here to add the bot to your server or you can click here to join our VacBot server
  2. Type $vacbot in text channels to show the wizard where you can see the link to add the bot to other servers and also an option to direct message to the bot. Click that link or clcik on profile.
  3. When you open Direct Message to the bot you can see every command using the help command
  4. First, find your State code using the show states command.
  5. Now find your district code using show district STATE_CODE -> Eg: for Kerala state, show district 17
  6. Now you get a list of districts with district codes, now you have to register so that you'll receive the notifications related to open slots for Covid Vaccination. For that use register DISTRICT_CODE AGE -> Eg: If you are from Malappuram District of Kerala and your age is 25, register 302 25
  7. If you want to know what all data we store, you can use the show mydata command
  8. To check available slots by Pincode you can use check pincode PINCODE_OF_YOUR_PLACE DATE_YOU_ARE_LOOKING_IN_DD-MM-YYYY_FORMAT command. For example -> If your Pincode is 676504 and you need to know the available slot on 25th May 2021, check pincode 676504 25-05-2021
  9. You can also update your age using update age YOUR_UPDATED_AGEcommand.
  10. Similarly, you can update the district using the update district NEW_DISTRICT_CODE command. For example if you want to change your district to Kozhikode you can use, update district 305, where 305 is the code for Kozhikode District
  11. If you want to unsubscribe to daily updates, send unregister



How to Configure Project?

  1. Clone Project
git clone https://github.com/aquibe/VacBot
  1. Change directory to VacBot
cd VacBot
  1. Install libraries
npm install
  1. Create file .env and add the line
BOT_TOKEN=enter_your_bot_token
MONGO_DBNAME=enter_mongoDB_name
MONGO_USERNAME=enter_your_mongoDB_Username
MONGO_PASSWORD=enter_your_bot_mongoDB_Password
MONGO_CLUSTER=enter_your_mongoDB_Cluster
  1. Run project
npm start



Libraries used

  1. Discord.js : To make our NodeJS Bot for Discord
  2. dotenv : To set environmental Variable
  3. https : To send API requests
  4. MongoDB : Used as Database
  5. scheduler : To schedule daily updates



Team VacBot

No. Name Github Discord ID
1 Aquibe V
(Team Lead)		 aquibe aquibe#7565
2 Shaheem PP the-codeholic Shaheem PP#8073
3 Naswih Abdurahiman neewtn Naswih#2013
Team ID: BFH/rechULibqwqj1WZ6i/2021