|
1 | 1 | # react-workflow-viz
|
2 | 2 | React component for visualizing CWL-like workflows (and similar data).
|
3 | 3 |
|
4 |
| -This is in alpha/beta phase. |
| 4 | +This repository is in alpha/beta phase, and is provided with very, very limited support to folks outside of HMS. Hopefully, in the future this will change! |
5 | 5 |
|
6 |
| - |
7 |
| -This package is being used by HMS-DBMI in the [4DN Data Portal](https://data.4dnucleome.org/experiment-set-replicates/4DNESMU2MA2G/#graph-section) to show provenance of analytical pipeline runs. |
| 6 | +Currently, this package is being used by HMS-DBMI in the [4DN Data Portal](https://data.4dnucleome.org/experiment-set-replicates/4DNESMU2MA2G/#graph-section) to show provenance of analytical pipeline runs. |
8 | 7 | Also being used in [CGAP](https://cgap.hms.harvard.edu) for similar purposes.
|
9 | 8 |
|
10 | 9 | Check out a live demo at [unpkg.com/@hms-dbmi-bgm/react-workflow-viz/index.html](https://unpkg.com/@hms-dbmi-bgm/react-workflow-viz/index.html). _Note: This link points to the index.html file in the distributable NPM package (and in this repo)._
|
11 | 10 |
|
12 | 11 | [](https://unpkg.com/@hms-dbmi-bgm/react-workflow-viz/index.html)
|
13 | 12 |
|
| 13 | +<br/> |
| 14 | +<br/> |
14 | 15 |
|
15 |
| -## Build demo |
| 16 | +## Try Demo Locally |
16 | 17 |
|
17 |
| -With a checkout of the repo: |
| 18 | +With a local clone and checkout of the repo: |
18 | 19 | ```
|
19 | 20 | npm install
|
20 | 21 | npm run build
|
21 | 22 | ```
|
22 | 23 |
|
23 | 24 | When it completes, load `file:///path-to-your-checkout/react-workflow-viz/index.html`.
|
24 |
| -New testdata won't show with `npm run build` unless is already present in unpkg/npm. For local development, do the following |
25 | 25 |
|
| 26 | +_Note: New test data won't show with `npm run build` unless it is already present in unpkg/npm._ |
26 | 27 |
|
27 |
| -### For Development |
| 28 | +<br/> |
28 | 29 |
|
29 |
| -For local development (watches file, serves on localhost:8100), run `npm run dev`. |
| 30 | +### For Contributors/Collaborators |
| 31 | +For local development, run `npm run dev` (watches `/src/` files, serves on `localhost:8100`). |
30 | 32 |
|
| 33 | +<br/> |
| 34 | +<br/> |
31 | 35 |
|
32 | 36 | ## Changelog
|
33 |
| -Changelog has been moved to `CHANGELOG.md` file in root directory. Please check there for updates. |
| 37 | +Changelog has been moved to `CHANGELOG.md` file in [repo's root directory](https://github.com/4dn-dcic/react-workflow-viz/blob/master/CHANGELOG.md). Please check there for updates. |
34 | 38 |
|
| 39 | +<br/> |
| 40 | +<br/> |
35 | 41 |
|
36 | 42 | ## Things to do
|
37 | 43 |
|
|
0 commit comments