https://github.com/contiamo/operational-visualizations
Custom data visualizations for ambitious data-driven interfaces
https://github.com/contiamo/operational-visualizations
Last synced: 5 months ago
JSON representation
Custom data visualizations for ambitious data-driven interfaces
- Host: GitHub
- URL: https://github.com/contiamo/operational-visualizations
- Owner: contiamo
- License: mit
- Archived: true
- Created: 2018-07-17T09:08:11.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-06-01T06:37:47.000Z (almost 5 years ago)
- Last Synced: 2024-11-11T21:14:01.685Z (6 months ago)
- Language: TypeScript
- Homepage: https://operational-visualizations.netlify.com/
- Size: 5.27 MB
- Stars: 10
- Watchers: 6
- Forks: 2
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Operational Visualizations [](https://travis-ci.com/contiamo/operational-visualizations) [](https://app.netlify.com/sites/operational-visualizations/deploys)
> 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](https://github.com/contiamo/operational-visualizations/tree/master-v6) branch. Documentation for v6 is [here](https://contiamo.github.io/operational-visualizations).
## Getting Started
This project is structured as a [monorepo](https://www.atlassian.com/git/tutorials/monorepos) for operational visualizations and related libraries. It consists of three libraries:
- [`@operational/frame`](packages/frame) - representation of multidimensional data.
- [`@operational/visualizations`](packages/visualizations) - set of visualisations primitives for building visualisations, React library. Uses frame as data source.
- [`@operational/grid`](packages/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
```sh
yarn
yarn start
```
to run tests
```sh
yarn test --watch
```
Open http://localhost:7000/
## Commiting changes
We follow [Conventional Changelog](https://www.conventionalcommits.org/en/). 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:
```sh
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](https://www.chromaticqa.com/) for providing the visual testing platform that help us catch unexpected changes on time.