# Data Hub Components
[![NPM Version][npm-version-image]][npm-url]
[![NPM Downloads][npm-downloads-image]][npm-url]
[![Build Status][circleci-image]][circleci-url]
[![LGTM Alerts][lgtm-alerts-image]][lgtm-alerts-url]
[![LGTM Grade][lgtm-grade-image]][lgtm-grade-url]
[![Coverage][codecov-image]][codecov-url]
[npm-url]: https://npmjs.org/package/data-hub-components
[npm-downloads-image]: https://badgen.net/npm/dm/data-hub-components
[npm-version-image]: https://badgen.net/npm/v/data-hub-components
[circleci-image]: https://circleci.com/gh/uktrade/data-hub-components.svg?style=svg
[circleci-url]: https://circleci.com/gh/uktrade/data-hub-components
[lgtm-alerts-image]: https://img.shields.io/lgtm/alerts/g/uktrade/data-hub-components.svg?logo=lgtm&logoWidth=18
[lgtm-alerts-url]: https://lgtm.com/projects/g/uktrade/data-hub-components/alerts/
[lgtm-grade-image]: https://img.shields.io/lgtm/grade/javascript/g/uktrade/data-hub-components.svg?logo=lgtm&logoWidth=18
[lgtm-grade-url]: https://lgtm.com/projects/g/uktrade/data-hub-components/context:javascript
[codecov-image]: https://codecov.io/gh/uktrade/data-hub-components/branch/master/graph/badge.svg
[codecov-url]: https://codecov.io/gh/uktrade/data-hub-components
Collection of React Components used by the Data Hub platform.
This component library makes heavy use of the [govuk-react](https://github.com/govuk-react/govuk-react) project.
## Usage
```bash
create-react-app demo-app
yarn add data-hub-components react react-dom
```
```jsx
import { ActivityFeed } from 'data-hub-components'
const activities = []
```
## Development
**Install dependencies**
Recommended Node.js version: `10.16.0`
Recommended Yarn version: `1.16.0`
```bash
nvm use # 10.16.0 from .nvmrc will be used
npm i -g yarn@1.16.0
yarn
```
**Start Storybook**
```bash
yarn start
```
**Run tests**
```bash
yarn test
```
Optionally, you can execute the CircleCI tests locally:
```bash
curl -fLSs https://circle.ci/cli | bash # Install CircleCI CLI
circleci local execute --job build
```
**Update Jest snapshots**
```bash
yarn test:update
```
**Create a release**
This project is using [Semantic Release](https://github.com/semantic-release/semantic-release).
When committing please always use the following pattern for you messages (scope, body and footer are optional):
```
():