Skip to content
This repository has been archived by the owner on Jun 6, 2020. It is now read-only.

contiamo/operational-visualizations

Repository files navigation

Operational Visualizations Build Status Netlify Status

This is a development branch for the latest version of @operational/visualizations (v7 or later). If you are looking for source code of v6 or earlier see master-v6 branch. Documentation for v6 is here.

Getting Started

This project is structured as a monorepo for operational visualizations and related libraries. It consists of three libraries:

  • @operational/frame - representation of multidimensional data.
  • @operational/visualizations - set of visualisations primitives for building visualisations, React library. Uses frame as data source.
  • @operational/grid - React component pivot table. Uses frame as data source. You can use grid together with visualizations to show visualisations in cells of pivot table.

Running locally

yarn
yarn start

to run tests

yarn test --watch

Open http://localhost:7000/

Commiting changes

We follow Conventional Changelog. To simplify commit process you can use yarn commit.

Releasing

Every commit to master is automatically released to canary channel.

To release to stable chanel use following commands:

git checkout master
git pull
yarn release:version

This command will bump versions of packages and push it to master (together with tags). CI server will do actual release.

Thanks

Thanks to Chromatic for providing the visual testing platform that help us catch unexpected changes on time.