Skip to content

Latest commit

 

History

History
84 lines (57 loc) · 2.69 KB

README.md

File metadata and controls

84 lines (57 loc) · 2.69 KB

Covid Vaccine Slack Bot

This is a Slack bot that alerts a channel or user when COVID-19 vaccine appointments become available in any number of geolocations in the United States.

Special thanks to vaccinespotter.org

Requirements

  1. Docker
  2. Docker Compose

Getting Started

  1. Create a new Slack App.
  2. Add the chat:write scope from the Oauth & Permissions page.
  3. Record the Bot User Oauth Token from the Oauth & Permissions page for later use. See Environment variables.
  4. Add your desired locaion(s). See Adding new locations.
  5. Run the bot. See Running the bot.

Adding new locations

To add a new location to be searched by the Slack bot, create a new json file in the "config" directory. For this example, we will add Boston, MA, ma-boston.json:

{
  "enabled": true,
  "channel": "#boston-covid-vaccine-availability",
  "latitude": 42.3600825,
  "longitude": -71.0588801,
  "radius": 10,
  "states": ["MA"],
  "test": false
}

Configuration parameters

Key Type Description
enabled boolean When set to true this location will be included in the bot's searches.
channel int The Slack channel or user ID to send notifications.
latitude float The latitude coordinate for this location.
longitude float The longitude coordinate for this location.
radius int Search radius (in miles) for nearby pharmacies.
state array States to include in the search, for example, a location in Kansas City may look like: ["KS", "MO"]
test boolean When set to true the bot will always alert for at least one location (vaccine available or not), as long as there are nearby pharmacies. Useful when testing the bot.

Environment variables

You must set the following environment variable to run the bot. You may add environment variables through docker, the OS or using a .env file in the project's root directory.

Key Type Description
SLACK_BOT_TOKEN string The API Token for the Slack bot.

Running the bot

To run the bot, run the following command in the root of the project:

docker-compose up -d --build

To stop the bot:

docker-compose down

License

The source code for the site is licensed under the MIT license, which you can find in the LICENSE.txt file.

All graphical assets are licensed under the Creative Commons Attribution 3.0 Unported License.