Delphi EpiVis

An interactive tool for visualizing epidemiological time-series data.

The site is live at https://delphi.cmu.edu/epivis/

The current stable main version is deployed at https://cmu-delphi-epivis.netlify.app/.

The next dev version is deployed at https://dev--cmu-delphi-epivis.netlify.app/.

Little piece of trivia: the first version of EpiVis was written on 2014-12-22. See the git history of this file for a legacy changelog which describes changes made prior to the migration to git around 2017.

Development Environment

One click solution:

node and npm are required for development.

To begin development, clone this repository and run

npm install

To lint or check for styling, run

npm run lint

To fix all possible linting errors, run

npm run fix

To run unit test, run

npm test

To run the development server, run

npm start

the website is then accessible via: http://localhost:8080/

Release Process

The release consists of multiple steps which can be all done via the GitHub website:

1. Go to create_release GitHub Action and click the Run workflow button. Enter the next version number or one of the magic keywords (patch, minor, major) and hit the green Run workflow button.
2. The action will prepare a new release and will end up with a new Pull Request
3. Let the code owner review the PR and its changes and let the CI check whether everything builds successfully
4. Once approved and merged, another GitHub action job starts which automatically will
   1. create a git tag
   2. create another Pull Request to merge the changes back to the dev branch
   3. create a GitHub release with automatically derived release notes
   4. create a Pull Request in www-main to update the website to the new release
5. Done

License

This repository is released under the MIT License.