This is a small showcase we create to illustrate the use of our BPTK Widgets library. The BPTK Widgets library is a collection of React-Widgets that let you build dashboards for simulations created with the BPTK Framework quickly and easily. You can download the BPTK Widgets Package from NPM.
Visit a live version of this dashboard at www.covid-sim.com.
To fully test the dashboard, you first need to ensure the backend COVID simulation server is running. You can find the COVID simulation and installation instructions in the companion repository at https://github.com/transentis/sim-covid-19.
Here are the steps to follow to run the COVID dashboard locally on your machine:
-
First you need to make sure that the COVID simulation REST API server is running on your machine - see the companion repository for instructions on how to set this up. The server should be running on http://localhost:5000.
-
Make sure you have node and yarn installed on your machine.
-
Clone this repository inside your environment
git clone https://git@github.com/transentis/sim-covid-dashboard.git -
Change directory:
cd sim-covid-dashboard -
Run these two commands in that directory:
yarn install && yarn build -
Start the dashboard server:
yarn start-local -
Open http://localhost:3000 with your browser to see the dashboard.
You are now ready to explore the widgets in our library and understand how they are connected to the simulation server.