Skip to content

A common repository of reusable react components presented in a storybook development environment.

Notifications You must be signed in to change notification settings

GhettoGeek/react-components-library

 
 

Repository files navigation

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, Package and Deploy

After merging your new component branch you can build the npm package from master and deploy the public storybook in one command using:

npm run deploy

This command runs the tests, builds the project, deploys to the storybook site and publishes the new package to npm for use in other projects. (n.b. if this is your first time, you'll need to make an npm account and request contribution permissions for this package.)

About

A common repository of reusable react components presented in a storybook development environment.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%