SandDance development

December 18, 2024 ยท View on GitHub

The SandDance repo is a monorepo made up of several packages, managed by npm workspaces. SandDance is a component stack with the layer hierarchy below:

  1. Deck.gl - WebGL rendering and canvas control.
  2. Vega - chart layout.
  3. sanddance-specs - Vega specifications for unit visualizations.
  4. sanddance - unit visualization chart views and selecting / filtering interaction.
  5. sanddance-test-umd - test of sanddance in UMD deployment.
  6. sanddance-test-es6 - test of sanddance in es6 deployment.
  7. sanddance-react - (optional) React wrapper for sanddance.
  8. sanddance-explorer - React-based data exploration component.
  9. sanddance-app - React-based sample application used on website.

System requirements

  • Node.js 16 or higher
  • NPM 8 or higher

Install

  1. Clone this repo
  2. npm install
  3. Install Jekyll to run the website locally.

Build

  1. npm run build

Run

Depending on which component you'd like to see, you can run in various ways.

Run website

  1. npm run deploy
  2. cd docs
  3. jekyll serve
  4. Visit http://127.0.0.1:4000/SandDance/
  5. For tests, visit http://127.0.0.1:4000/SandDance/tests

Run sanddance-app with watchers

  1. npm start
  2. Visit http://127.0.0.1:8085/