| provenance-core | Data structures and tracking for interaction provenance in web applications |
| provenance-tree-visualization | D3 based interactive visualization of provenance graph |
| provenance-tree-visualization-react | React wrapper for provenance-tree-visualization |
| slide-deck-visualization | D3 based slide deck GUI |
| provenance-tree-calculator-demo | Simple calculator demo to show provenance features |
| brainvis (private) | Brainvis demo |
| provenance-task-list (private) | Task list (Brainvis dependency) |
| ami (private) | custom AMI (Brainvis dependency) (https://github.com/FNNDSC/ami) |
- Node (For brainvis, use node v10.15.3)
The different modules are dependent on one another, to be able to work on several modules at the same time use yarn workspaces. Make sure you have node installed (8.x), and yarn. Then (paste in terminal as a whole, or per instruction):
mkdir prov && cd prov
# clone repos that you want:
git clone [email protected]:VisualStorytelling/provenance-core.git
git clone [email protected]:VisualStorytelling/slide-deck-visualization.git
git clone [email protected]:VisualStorytelling/provenance-tree-visualization-grouping.git provenance-tree-visualization
# if working on brainvis:
git clone [email protected]:VisualStorytelling/brainvis.git
git clone [email protected]:VisualStorytelling/provenance-task-list.git
git clone [email protected]:VisualStorytelling/ami.git
# create a package.json for the workspace:
# Angular doesn't play nice in a yarn workspace, the nohoist ensures packages are installed in the subfolders' node_modules instead of the root.
# Add `brainvis`, `provenance-task-list` and `ami` to packages if working on brainvis
cat <<EOT > package.json
{
"private": true,
"workspaces": {
"packages": [
"provenance-core",
"provenance-tree-visualization",
"provenance-task-list",
"slide-deck-visualization",
"ami",
"brainvis"
],
"nohoist": [
"**/@angular*",
"**/@angular*/**",
"**/@ngtools*",
"**/@ngtools*/**"
]
}
}
EOT
# install dependencies:
yarn install
# Do initial builds, to setup dependencies
(cd provenance-core && yarn build)
(cd provenance-tree-visualization && yarn build)
(cd slide-deck-visualization && yarn build)
# if brainvis:
# (cd provenance-task-list && yarn build)
# (cd ami && yarn build:ami)
# the ami build crashes, but it should still work, expect the following error:
# TS2694: Namespace '"/home/tom/Projects/visualstorytelling/ami/node_modules/three/src/Three"' has no exported member 'OrbitControls'.
#
# Use `yarn watch` in each directory to auto build after updates.
# Run demo or brainvis:
cd brainvis
yarn start
# Now you can open your browser on http://localhost:8080/