lp-react-components

Install in your own project

To add this set of components to your project

npm i lp-react-components

Then you can import the components like this

import React from 'react'

import { MyComponent }  from 'lp-react-components'

const Component = () => <MyComponent someProperty="some-value"/>

See the storybook for a list of all the components

Development on this repo

To make change to this repo, or test it locally, first clone this repo and then

npm i

Running the storybook

To test the storybook locally

npm run storybook

Testing the project

You can run the unit tests by running

npm run test

or if you want to see code coverage for the project

npm run coverage

Branching strategy

1. Branch off master (prefix the repo with either feature/ or bug/ )
2. Create a PR back to master
3. Get PR approved then merge it

Deploying documentation

To deploy the documentation (styleguide and storybook) to github pages

  npm run deploy

Updating the npm package

If any changes are made to the components, we will need to update the version. Make sure all your changes have been committed to the repo before running

npm version patch

To publish the package to npm to make it available for other projects

npm login
npm publish

License

MIT © pkibbey