GoodData React Components

React.js components for building visualizations on top of GoodData platform

Getting started

Usage

With yarn installed, go to your project directory and run

$ yarn add @gooddata/react-components

If you prefer npm run

$ npm install --save @gooddata/react-components

Documentation

Documentation

Develop

Running the development

To develop, you need to run the typescript compiler. By running yarn dev, the typescript compiler will be run in watch mode.

$ cd gooddata-react-components
$ yarn dev

If you just need to build the CSS files from SASS, run

$ yarn build-css

To see and validate the react components, you can use Storybook. To run the storybook in development mode, run

$ yarn storybook

To deploy the production version of storybook, run

$ yarn build-storybook

Running the tests

To validate using tslint, run

$ yarn validate

Storybook visual regression tests

Visual regression testing for Storybook is provided by @gooddata/test-storybook package.

Deployment

git checkout master && git pull upstream master --tags
npm version [major|minor|patch] -m "Release v%s"
npm publish
git push upstream master --tags

Examples

For more details see ./examples/README.md

cd examples
yarn install
yarn dev

Contributing

Report bugs and features on our issues page.

License

Copyright (C) 2007-2017, GoodData(R) Corporation. All rights reserved.

For more information, please see LICENSE