UNPKG

fk-react-ui-components

Version:

Step 1 : Create a file in [ Seeds / Plants / Trees ] <br> Step 2 : It should export an Object with component name and story Component [Refer other components] <br> Step 3 : Story Component should return a react component <br> Step 3 : Created file should

57 lines (39 loc) 1.59 kB
### TO ADD A STORY Step 1 : Create a file in [ Seeds / Plants / Trees ] <br> Step 2 : It should export an Object with component name and story Component [Refer other components] <br> Step 3 : Story Component should return a react component <br> Step 3 : Created file should be imported in Seeds/index.js or Plants/index.js or Trees/index.js <br> Step 4 : Story Component should import what ever the component to be showcased from the components dir. <br> Step 5 : Story should use knobs to customize its props [https://github.com/storybooks/storybook/tree/master/addons/knobs ]. <br> ### TO ADD A COMPONENT / HOC Step 1 : Add a component in components dir <br> Step 2 : Add a story for the component added <br> Step 3 : Raise a PR against master <br> Step 4 : Once merged create release TAG <br> ### TO USE IT IN ANY REPO Step 1 : add entry in package.json with https://github.com/Flipkart/react-ui-components.git#<TAG_VERSION_NO> <br> Step 2 : npm i <br> Step 3 : import react-ui-components in the working directory <br> ### TESTING #### Tools | Name | Description | | :-------------:|--------------| | [Jest](https://facebook.github.io/jest/) | A JavaScript library for building user interfaces. | | [Enzyme](http://airbnb.io/enzyme/) | Predictable state container for JavaScript apps. | #### Commands To run all the test cases ```sh npm run test ``` To run watch mode ```sh npm run test-watch ``` To collect test coverage information ```sh npm run test-cover ``` To collect test coverage information and open the info in browser ```sh npm run coverage ```