# 🔷 Blue

[![Build Status](https://travis-ci.org/helpscout/blue.svg?branch=master)](https://travis-ci.org/helpscout/blue) [![Coverage Status](https://coveralls.io/repos/github/helpscout/blue/badge.svg?branch=master)](https://coveralls.io/github/helpscout/blue?branch=master) [![npm version](https://badge.fury.io/js/%40helpscout%2Fblue.svg)](https://badge.fury.io/js/%40helpscout%2Fblue) ![node](https://img.shields.io/badge/node-8.11.3-blue.svg) ![npm](https://img.shields.io/badge/npm-6.4.1-blue.svg)

Help Scout's React component library

<img src="https://github.com/helpscout/blue/raw/master/images/Blue.png" width="250">

## Live Demo

Check out Blue's [Storybook](https://hsblue.surge.sh/):

https://hsblue.surge.sh/

## Install

```
npm install @helpscout/blue --save
```

## Getting Started

After cloning this repo down, run:

```
npm install
```

Once everything is installed, run:

```
npm start
```

Check out Blue's Storybook at http://localhost:8900/ in your browser!

## Testing

To run Jest in watch mode, run:

```
npm run dev
```

To execute all the tests (with Coverage reporting), run:

```
npm run test
```

## Publishing

To publish and release a new version of Blue, run the following command:

```
npm run release
```

You'll be presented with a CLI prompt with options.
Pick the one you want, and that's it! The script will take care of the rest (from testing to publishing).

## Deploying Storybook

To deploy the Storybook, run the following command:

```
npm run deploy
```

## Extras

![You're my boy, Blue!](./images/yourmyboyblue.gif)

> You're my boy, Blue!