# GoodStrap

> React UI library

## Setup

1. Install [Node.js](http://nodejs.org) and [Yarn](https://classic.yarnpkg.com) (for versions, see [config](docker/.config)).

2. Run `yarn install --frozen-lockfile` to install the npm dependencies and bootstraps the environment.

## Develop

```shell
yarn storybook
```

Will start react storybook at http://localhost:9001/

Please follow GoodData coding styles for [JavaScript](https://github.com/gooddata/gdc-js-style) and [CSS](https://github.com/gooddata/gdc-css-style).

Optionally you can install terminal-notifier to get notified about build status.
The easy way is to use Homebrew:

```shell
brew install terminal-notifier
```

## Run unit tests

```shell
yarn test
```

Will start Jest in watch mode.

## Build

```shell
yarn build-storybook
```

Will build production version of storybook into **dist-storybook/** folder.

## Usage

```shell
yarn add @gooddata/goodstrap@X.Y.Z
```

## Versioning

This project was using [Semantic Versioning](http://semver.org) version numbering in the past, but we have switched to major versions only.

## Releasing

For releasing, use the [jenkins job](https://checklist.intgdc.com/job/client-libs/job/gdc-goodstrap-release/). Find more about the job in [Confluence](https://confluence.intgdc.com/display/FD/Frontend+CI+npm+publish).

## License

(C) 2007-2018 GoodData Corporation