Skip to content

lietu/koroonakaart

 
 

Repository files navigation

Koroonakaart

Koroonakaart is a project which aims to give accurate and up-to-date information about the Covid-19 epidemic in Estonia.

This is a fork of the repo managed by Open Knowledge Estonia: https://github.com/okestonia/koroonakaart.

GitHub Actions are used to automatically download latest data and rebuild the site. The data which is not easily available from external APIs is automatically updated to the repository after scraping.

The generated site is hosted on GitHub Pages with Cloudflare caching at https://koroonakaart.cocreators.ee/ - consider this a backup of https://koroonakaart.ee

Data

All data for the application can be accessed directly via the links:

Project setup

Install prerequisites

Install Python appropriately for your environment. Especially on Windows, if you installed from Microsoft Store, please ensure the "Scripts" directory is added on your PATH properly.

You can check with where python.exe where Python was installed to, and you should ensure the Python3x\Scripts directory is included in your PATH (https://datatofish.com/add-python-to-windows-path/). Alternatively if this does not work, after installing pre-commit run where /R C:\ pre-commit.exe to locate the correct Scripts directory.

Install poetry to manage Python dependencies: https://python-poetry.org/docs/#installation

Install pre-commit to do automatic code analysis and formatting before committing changes: https://pre-commit.com/#install

Get/update data from TEHIK API

After cloning the repository, you will need to download the latest Estonian COVID-19 data from TEHIK in order for the app to compile, after which we can generate the chart data for the frontend.

poetry install
poetry run download
poetry run generate

# Or if you have plenty of memory and CPU - this will take about 14GB of RAM and optimize time spent
poetry run generate --parallel 6
# Larger numbers will eat greatly more RAM without significantly improving performance

If you're working on the data generators, you can run an individual script as well:

poetry run python build/generate_x.py

Note: At present, the update process won't work if carried out between midnight and the time that TEHIK updates their data, which is typically sometime between 11am and noon Estonian time. We realise this isn't ideal and are working to improve the process.

Install front-end dependencies

To Customize Vue.js configuration see Configuration Reference.

cd koroonakaart/
pnpm install

Compiles and hot-reloads for development

pnpm run serve

Compiles and minifies for production

pnpm run build

Lints and fixes files

pnpm run lint

How to contribute?

If you have a suggestion about something that could be improved or wish to help with the technical development, please take a look here: https://github.com/okestonia/koroonakaart/issues

All suggestions and ideas are welcome. Please feel free to fork the project, raise new issues, or make pull requests.

The project is primarily voluntary and has received no funding other than from members of the community. Open Knowledge Estonia https://www.facebook.com/okestonia/ has opened a separate bank account to receive support for infrastructure and core maintance:

MTÜ Open Knowledge Estonia EE607700771004696794

We will publish the amount of all support received and keep costs transparent.

History

How the team formed at Hack the Crisis

The app was originally built in around 24 hours as part of the Hack the Crisis hackathon put on by Garage48 in Estonia. It was developed by Harry Sild (@Kypsis), Chris Thompson (@neuroactive), Joonas Puura (@PuuraJ), and Keegan McBride ( @Keeganmcbride). Hanna Maria Mägi came up with the initial design. Maarja Leena Saar and Sven Illing have also contributed.

License and data information

This repository is maintained as an open source project and released under an MIT license.

⚠️ The Highcharts component of this project is licensed under a more restrictive license: CC-BY-NC, which prevents you from using that component for commercial purposes. Before using the Highcharts dependency, please ensure that your use case is compliant with this licence.

The regional and settlement data is from Maa-amet version 20200601 and demographic data is provided by Statistikaamet.

The COVID-19 related data has been optained from TEHIK via https://www.terviseamet.ee/et/koroonaviirus/avaandmed and is available under CC0.

Financial support

This fork has been made possible thanks to Cocreators and Lietu. You can help us continue our open source work by supporting us on Buy me a coffee.

"Buy Me A Coffee"

About

App to show statistics about the COVID-19 epidemic in Estonia.

Resources

License

MIT, CC0-1.0 licenses found

Licenses found

MIT
LICENSE
CC0-1.0
LICENSE-data

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Vue 58.9%
  • Python 29.7%
  • JavaScript 6.3%
  • HTML 2.6%
  • CSS 1.8%
  • Dockerfile 0.7%