Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rohitjmathew/vaccine-slack-notifier
Slack Notifier for India's 18+ Vaccine Appointment
https://github.com/rohitjmathew/vaccine-slack-notifier
Last synced: 12 days ago
JSON representation
Slack Notifier for India's 18+ Vaccine Appointment
- Host: GitHub
- URL: https://github.com/rohitjmathew/vaccine-slack-notifier
- Owner: rohitjmathew
- License: mit
- Created: 2021-05-03T15:57:56.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-05-05T19:14:10.000Z (over 3 years ago)
- Last Synced: 2024-10-06T05:22:25.887Z (about 1 month ago)
- Language: JavaScript
- Homepage:
- Size: 33.2 KB
- Stars: 4
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Vaccine Slack Notifier
Slack Notifier for India Vaccine Appointment. This checks the Co-WIN portal periodically to find vaccination slots available in the provided pin codes and for your age.
It triggers a slack notification to your channel added as a part of environment variable for all the pin codes added to the environment variable
*Note: This utility uses COWIN Public APIs data. There is a delay noticed with respect to updating data with respect to slot availability. Do use the utility with that in mind*
## Prerequisites
- You need to setup slack incoming webhooks to be able to receive alerts. Follow the following [tutorial](https://api.slack.com/messaging/webhooks) and use the webhook link in your environment variables
- You need a DigitalOcean account to deploy this on a cloud provider. If not click on the deploy button below and first create your account.
## Deployment
To deploy this project click the button below to deploy the code on DigitalOcean
[](https://cloud.digitalocean.com/apps/new?repo=https://github.com/rohitjmathew/vaccine-slack-notifier/tree/main&refcode=4c19f19961b8)
## Environment Variables
To run this project, you will need to add the following environment variables to your .env file
`PINCODES` - List of pin codes you want separated by a space
`SLACK_WEBHOOK` - The Webhook link for slack to trigger messages
`SCHEDULE` - The Cron Entry to control frequency of hits
`AUTH_TOKEN` - Your CoWin Auth Token. This needs to be updated everyday as the token is valid for a single day.
An example version can be seen [here](https://github.com/rohitjmathew/vaccine-slack-notifier/blob/main/.env.sample)
## Run Locally
Clone the project
```bash
git clone https://github.com/rohitjmathew/vaccine-slack-notifier
```
Go to the project directory
```bash
cd vaccine-slack-notifier
```
### Using PM2
- Install PM2
```bash
npm install pm2 -g
```
- Start the server
```bash
make pm2-run
```
- Stop the server
```bash
make pm2-stop
```
### Using Docker
- Ensure Docker is installed
- Start the server
```bash
make docker-run
```
- Stop the server
```bash
make docker-stop
```
## Screenshots
## Contributing
Contributions are always welcome!
See [CONTRIBUTING.md](/CONTRIBUTING.md) for ways to get started.
## License
[MIT](/LICENSE)
This readme was created with [readme.so](https://readme.so) :)