/covid

Static site for local Covid 19 data

Primary LanguageVueMIT LicenseMIT

Covid-19 logo

Local Covid-19 Stats & News

Version MIT License Issues

The overall goal of this project is to make a data hub for a community (city, town, village).

Live Site | Install | Setup | Contribute

Install

# install dependencies
$ npm install

# serve with hot reload at localhost:3000
$ npm run dev

# build for production and launch server
$ npm run build
$ npm run start

# generate static project
$ npm run generate

For detailed explanation on how things work, check out Nuxt.js docs.

Setup

If you want to run the full site locally, you'll need to setup Environment Variables by creating a .env file at the root of the project with the contents:

NODE_ENV=dev
PLACES_APP_ID=XXXXXXXXXXXX
PLACES_API_KEY=XXXXXXXXXXXX
API_URL=https://api.covid.readable.report

We use Nuxt dotenv module to pull in Environment Variables.

You can signup for a free Algolia Places account to get API keys.

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check issues page. You can also use the labels to sort by feature or bug. We also have a contributing guide you can look at.

Steps

  1. Fork it
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request

Show your support

Give a ⭐️ if this project helped you!

📝 License

This project is MIT licensed.

Author

👤 Readable Report