sigmavirus24 / covid-vaccine-spotter

Home Page:https://www.vaccinespotter.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

COVID-19 Vaccine Spotter

A tool to help you track down COVID-19 vaccine appointment openings at your state's pharmacies. The code behind https://www.vaccinespotter.org.

Development Setup

Requirements:

  • Node.js 14+
  • Yarn

This process is clunky right now, so my apologies.

  1. Clone the repo: git clone https://github.com/GUI/covid-vaccine-spotter.git
  2. Install dependencies (inside the repo): yarn install
  3. Download data from the API for the website to run. Note these example steps just download a few files to get things running, but it's not an entire dataset. You can download other states data, but I know this is currently a bit cumbersome.
    • mkdir -p website/static/api/v0/states/CO
    • curl -o website/static/api/v0/states.json https://www.vaccinespotter.org/api/v0/states.json
    • curl -o website/static/api/v0/states/CO.json https://www.vaccinespotter.org/api/v0/states/CO.json
    • curl -o website/static/api/v0/states/CO/postal_codes.json https://www.vaccinespotter.org/api/v0/states/CO/postal_codes.json
  4. To run the development server for the website: yarn run dev. The development site should then be available at http://localhost:3000/.

TODO: While this should cover running the website with existing, this doesn't cover running the database and other pieces necessary for working on the scanners or other backend pieces. Still need to document that part.

Very Beta API

All of the data being collected is published as JSON files here: https://www.vaccinespotter.org/api/

Subscribe to this discussion for any announcement of API changes: GUI#27

License

This project is licensed under the terms of the MIT license.

About

https://www.vaccinespotter.org

License:MIT License


Languages

Language:JavaScript 79.4%Language:Vue 20.0%Language:HCL 0.4%Language:Dockerfile 0.2%Language:HTML 0.0%