Blue 🔷

Help Scout's React component library
Install
npm install @helpscout/blue --save-dev
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
That's it! The script will take care of the rest (from testing to publishing). This will patch bump the version on Github and npm.
Additional options
Command | Description |
---|
npm run release:major | Publish with a major version bump. 1.0.0 -> 2.0.0 |
npm run release:minor | Publish with a minor version bump. 0.1.0 -> 0.2.0 |
npm run release:patch | Publish with a patch version bump. 0.0.1 -> 0.0.1 |
Todos
Check out our ever-changing Todos notes here.

You're my boy, Blue!