| 1 | # Coupon components
|
| 2 | All components for the coupon apps.
|
| 3 | You can view [all Components](https://silverhill.github.io/coupon-components)
|
| 4 |
|
| 5 | We are using [postcss-modules-values](https://www.npmjs.com/package/postcss-modules-values) and [PostCss Next](http://cssnext.io/)
|
| 6 |
|
| 7 | Storybook Docs: [Storybook](https://storybook.js.org/) and [knobs](https://github.com/storybooks/storybook/tree/master/addons/knobs)
|
| 8 |
|
| 9 | ## Install and Use
|
| 10 | * `yarn add -S coupon-components`
|
| 11 | * Import styles in the root App
|
| 12 | `import 'coupon-components/build/css/styles.css'`
|
| 13 | * ``` import { Button } from 'coupon-components' ```
|
| 14 |
|
| 15 | ## Dev Environment
|
| 16 | * install with `yarn`
|
| 17 | * run dev environment `yarn storybook`
|
| 18 |
|
| 19 | ## Build and Publish package
|
| 20 | * `yarn build` to transpile and compile for publish package
|
| 21 | * change the version of new package
|
| 22 | * `npm publish`
|
| 23 |
|
| 24 | ## Build Documentation
|
| 25 | * `yarn build-docs` for compile and publish stoybook in github project
|
| 26 |
|
| 27 | ## How to Publish
|
| 28 | * `npm run build` && `npm run build-docs`
|
| 29 | * `npm version patch` if is a fix | `npm version minor` if is a new component | `npm version major` if is a new release with diferent issues
|
| 30 | * `npm publish` |
| \ | No newline at end of file |