/CovidSandbox

A small project to visualize changes and trends for the COVID-19 pandemic and improve my technologies skills.

Primary LanguageC#MIT LicenseMIT

Build Code Smells Coverage

CovidSandbox

This is a small project to visualize changes and trends for the COVID-19 pandemic and improve my technologies skills.

Prerequsites

General prerequisites for all scenarios is an installed command processor. PowerShell v.5.1 or newer for Windows, bash - for Linux/Mac.

Local build

To build a project locally, you need the preinstalled .NET Core SDK 3.1. You can find information about how to install it here.

To run workbooks, you need a Jupyter server with additional python modules:

Docker build

To build and run a project with a docker, you need an installed Docker Desktop

How to use

This repo contains submodules, so it's highly recommended to clone it with the following command:

git clone --recursive --jobs 8 https://github.com/guest512/CovidSandbox.git 

There are four scripts for each platform:

  • build-and-run-local - builds all necessary tools and runs them. After the script finish, go to the ReportsProcessing folder and open (create new) a jupyter workbook to process the results.
  • build-and-run-docker - creates all necessary containers and runs them. After the script finish, open a link from the script output and open (create new) a jupyter workbook to process the results.
  • run-local - same as build-and-run-local but don't build anything. Useful when you update data source and want to regenerate/update reports.
  • run-docker - same as previous but for docker containers.

NOTE: At the moment build-and-run-docker and run-docker scripts not only build tools and prepare data, but also builds web-site and move results to wwwroot folder in the project root.

There are two data sources for the moment:

git submodule update --remote 3rdparty/DataSources/JHopkins
  • Yandex - a manually updated file grabbed from the public Yandex Dashboard. There is no need to update it anymore since all new cases are stored in the JHopkins data source. However, it's useful to get more detailed data about Russia cases at the beginning of the pandemic.