Skip to content

Latest commit

 

History

History
33 lines (19 loc) · 1.29 KB

README.md

File metadata and controls

33 lines (19 loc) · 1.29 KB

React Component Library

React and Redux code to be reused across projects presented in a storybook dev environment.

Usage

To install:

npm i @linn-it/linn-form-components-library

You can explore components currently in the project by looking at the storybook.

To use components, import them (already transpiled to cjs) as follows:

import BackButton from '@linn-it/linn-form-components-library/cjs/BackButton';

Development

In the project directory, you can run:

npm run storybook

which runs the storybook dev server.

Make a new branch and add your new components, tests and stories in the relevant directories and view them in your local storybook. When you are ready to share your new component, add it to the rollup.config.js following the existing syntax and it will be transpiled and presented as a module export by the build command. Up the version number in package.json and then make a pull request for review.

Build, Test, Package and Deploy

The build and tests will run automatically on commits to your branch if you have a pull request open.

When you merge to master (remember to up the package version number before you do) your changes will be published to npm and the new storybook will be deployed to github pages.