covid19-dashboard/README.md

Dashboard App displaying COVID-19 numbers by country

<p align="center">
  <a href="https://npmcharts.com/compare/covid19-dashboard?minimal=true"><img src="https://img.shields.io/npm/dm/covid19-dashboard.svg" alt="Downloads"></a>
  <a href="https://www.npmjs.com/package/covid19-dashboard"><img src="https://img.shields.io/npm/v/covid19-dashboard.svg" alt="Version"></a>
  <a href="https://www.npmjs.com/package/covid19-dashboard"><img src="https://img.shields.io/npm/l/covid19-dashboard.svg" alt="License"></a>
  <a href="https://discord.gg/6p8paPq"><img src="https://img.shields.io/discord/656620537514164249?label=discord%20chat" alt="Chat"></a>
  <a href="./CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-welcome-green.svg" alt="PRs Welcome"></a>
</p>

# neo.mjs covid-dashboard
A multithreading Dashboard showing countries affected by COVID-19.

Switch the Main tabs (Table, Gallery & Helix). When selecting a country inside the top-left SelectField, this will update
the route, triggering a selection update on the active view. Selecting an item inside the active view will adjust the
route as well, updating the SelectField as well. Switching tabs will adjust the current selection.

The App supports the dark & light themes.

You can configure and sort the gallery & helix with the controls on the right side, resulting in a firework of CSS3 transitions.

This is a perfect performance demo for the webworkers driven UI framework <a href="https://github.com/neomjs/neo">neo.mjs</a>.

## Content
1. <a href="#online-versions">Online Versions</a>
2. <a href="#demo-video">Demo Video</a>
3. <a href="#preview-images">Preview Images</a>
4. <a href="#getting-started">Getting Started</a>
5. <a href="#docs-app">Docs App</a>
6. <a href="#multithreading">Multithreading</a>
7. <a href="#attribution">Attribution</a>

## Online Versions
You can find the Online Versions <a href="https://neomjs.github.io/pages/">here on GitHub Pages</a> (COVID-19 Dashboard App).

## Demo Video
https://www.youtube.com/watch?v=BhSZS6_UlO4

## Preview Images
<img src="https://raw.githubusercontent.com/neomjs/pages/master/resources/images/covidDashboard/v2/table.png">

<img src="https://raw.githubusercontent.com/neomjs/pages/master/resources/images/covidDashboard/v2/gallery.png">

<img src="https://raw.githubusercontent.com/neomjs/pages/master/resources/images/covidDashboard/v2/helix.png">

<img src="https://raw.githubusercontent.com/neomjs/pages/master/resources/images/covidDashboard/v2/world.png">

## Getting Started
1. Clone this repo to your system to get the project files
   ```sh
   git clone https://github.com/neomjs/covid-dashboard.git
   ```

2. Open the checked out top level folder inside your terminal
   ```sh
   cd covid-dashboard
   ```

3. Install the required node modules & run all relevant build scripts at once
   ```sh
   npm run build-all
   ```

4. Make sure to use a local WebServer!
   * Use a local webserver of your choice
   * OR `npm run server-start`

## Docs App
Since this app shell was created using:
> npx neo-app

We do get documentation views for our app source code out of the box:
> http://localhost:8080/docs/

<img src="https://raw.githubusercontent.com/neomjs/pages/master/resources/images/covidDashboard/v2/docs.png">
   
## Multithreading
In case you want to take a closer look at the workers setup, take a look into the Chrome dev tools Sources:

<img src="https://raw.githubusercontent.com/neomjs/pages/master/resources/images/covid_workers.png">

Your app code will get loaded into the App thread.

## Attribution
1. The logos were created by <a target="_blank" href="https://www.linkedin.com/in/sebastian-d-036aab6/">Sebastian Driefmeier</a>. Thank you!
2. The logos are based on the image from <a target="_blank" href="https://phil.cdc.gov/Details.aspx?pid=23312">CDC Public Health Image Library (PHIL)</a>, so credits to the content providers CDC/ Alissa Eckert, MS; Dan Higgins, MAMS..
3. Data provided by: <a target="_blank" href="https://github.com/NovelCOVID/API">NovelCOVID / API</a>.
4. Country Flag Icons made by <a target="_blank" href="https://www.flaticon.com/authors/freepik" title="Freepik">Freepik</a> from <a target="_blank" href="https://www.flaticon.com/" title="Flaticon"> www.flaticon.com</a>..
5. Charts got created with <a target="_blank" href="https://www.amcharts.com/docs/v4/">amCharts 4</a>.
6. The App is created with the webworkers driven UI framework <a target="_blank" href="https://github.com/neomjs/neo">neo.mjs</a>.

### Join our Slack Channel for questions & feedback:

<a href="https://join.slack.com/t/neotericjs/shared_invite/enQtNDk2NjEwMTIxODQ2LWRjNGQ3ZTMzODRmZGM2NDM2NzZmZTMzZmE2YjEwNDM4NDhjZDllNWY2ZDkwOWQ5N2JmZWViYjYzZTg5YjdiMDc">Slack Channel Invite Link</a>

<br><br>
Build with :heart: in Germany.

<br><br>
Copyright (c) 2020 - today, <a href="https://www.linkedin.com/in/tobiasuhlig/">Tobias Uhlig</a>