GoodData React Redux Components

Additional React + Redux components for building visualizations on top of GoodData platform

Getting started

Usage

To add gooddata-react-redux-components to your project, you need these peer dependencies:

- React
- Redux
- @gooddata/react-components

If you don't have the peer dependencies installed, go to your project directory and run

$ yarn add react redux @gooddata/react-components

With yarn installed, go to your project directory and run

$ yarn add @gooddata/react-redux-components

Documentation

Documentation in Confluence

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-redux-components
$ yarn dev

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

Deployment

$ git checkout master && git pull upstream master --tags
$ npm version patch -m "Release v%s"
$ npm publish --access=restricted
$ git push upstream master --tags

Contributing

Report bugs and features on our issues page.

License

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

For more information, please see LICENSE