@helpscout/blue
v2.0.0
Published
Help Scout's React component library
Downloads
304
Readme
🔷 Blue
Help Scout's React component library
Live Demo
Check out Blue's Storybook:
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!