Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/deepankkartikey/covid-vaccine-notifier
Notifies the user on Desktop and SMS when a slot for the vaccine is available.
https://github.com/deepankkartikey/covid-vaccine-notifier
cli covid-19 nodejs vaccine vscode
Last synced: 28 days ago
JSON representation
Notifies the user on Desktop and SMS when a slot for the vaccine is available.
- Host: GitHub
- URL: https://github.com/deepankkartikey/covid-vaccine-notifier
- Owner: deepankkartikey
- License: mit
- Created: 2021-05-29T18:25:03.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-06-02T15:34:03.000Z (over 3 years ago)
- Last Synced: 2023-03-10T07:54:12.114Z (almost 2 years ago)
- Topics: cli, covid-19, nodejs, vaccine, vscode
- Language: JavaScript
- Homepage:
- Size: 87.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
## Vaccine Slot Notifier
A Node CLI application to provide push notifications on desktop and sms notification on your mobile for availability of vaccine slots.
Inputs include:
- Pincode
- Date (mm-dd-yyyy) or default-blank string('')API Used: [CoWin Public API](https://apisetu.gov.in/public/marketplace/api/cowin#/Appointment%20Availability%20APIs/findByPin)
### The CLI will perform the follow functions
- Ability to get slots by pincode.
- Ability to filter slots by ages as we have slots by 18-45 and 45 and above.
- Ability to send desktop notification.
- Date for search criteria is defaulted to present day.
- Ability to send SMS notification (if you enable API_KEY).### Requirements to run (or) develop on system
- [Visual studio code](https://code.visualstudio.com/download)
- Install Node js on your system.
- [Docs](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
- [Video](https://www.youtube.com/watch?v=JINE4D0Syqw)### How to Use
- Clone repository and run command: `npm install`
- CLI Commands`cowin` : shows all available options
(currently only supports search by pincode)`cowin `
- replace `` by some valid value like 110042
- replace `` either by `''` (blank string) or desired date- select age group from drop down presented on CLI
### Screenshots of notifications
- Push notification on system- Text Notification
### Result
- Push notification on desktop for available slots with details like
- address of center
- available number of doses
- available time slots- There is a provision to setup SMS service also (currently disabled as service is not free)
- API-KEY can be obtained [fast2sms](https://www.fast2sms.com/dashboard/dev-api) and place API_KEY = _value from fast2sms_
- (uncomment corresponding method for SMS notification `notifyOnSMS(message)`)### Node Package used
- Axios –for calling the different api’s
- Chalk – for beautifying the console output
- Commander – giving the different options and command in CLI
- Inquirer – for getting user input for entering the age filter
- Node-notifier – send desktop notification
- Tty-table – format our table output
- fast-two-sms - as a messaging service