You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
An interactive tool for visualizing epidemiological time-series data.
@@ -15,6 +17,52 @@ Little piece of trivia: the first version of EpiVis was written on 2014-12-22.
15
17
See the git history of this file for a legacy changelog which describes changes
16
18
made prior to the migration to git around 2017.
17
19
20
+
## Development Environment
21
+
22
+
One click solution: [](https://gitpod.io/#https://github.com/cmu-delphi/www-epivis)
23
+
24
+
`node` and `npm` are required for development.
25
+
26
+
To begin development, clone this repository and run
27
+
28
+
```sh
29
+
npm install
30
+
```
31
+
32
+
To lint or check for styling, run
33
+
34
+
```sh
35
+
npm run lint
36
+
```
37
+
38
+
To run unit test, run
39
+
40
+
```sh
41
+
npm test
42
+
```
43
+
44
+
To run the development server, run
45
+
46
+
```sh
47
+
npm start
48
+
```
49
+
50
+
the website is then accessible via: http://localhost:8080/
51
+
52
+
### Release Process
53
+
54
+
The release consists of multiple steps which can be all done via the GitHub website:
55
+
56
+
1. Go to [create_release GitHub Action](https://github.com/cmu-delphi/www-epivis/actions/workflows/create_release.yml) 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.
57
+
1. The action will prepare a new release and will end up with a new [Pull Request](https://github.com/cmu-delphi/www-epivis/pulls)
58
+
1. Let the code owner review the PR and its changes and let the CI check whether everything builds successfully
59
+
1. Once approved and merged, another GitHub action job starts which automatically will
60
+
1. create a git tag
61
+
1. create another [Pull Request](https://github.com/cmu-delphi/www-epvis/pulls) to merge the changes back to the `dev` branch
62
+
1. create a [GitHub release](https://github.com/cmu-delphi/www-epivis/releases) with automatically derived release notes
63
+
1. create a [Pull Request in www-main](https://github.com/cmu-delphi/www-main/pulls) to update the website to the new release
64
+
1. Done
65
+
18
66
## License
19
67
20
68
This repository is released under the **MIT License**.
0 commit comments