https://github.com/lucbpz/react-component-boilerplate

Creates an isolated environment for a React component that can be exported to an npm package
https://github.com/lucbpz/react-component-boilerplate

Last synced: 22 days ago
JSON representation

Creates an isolated environment for a React component that can be exported to an npm package

• Host: GitHub
• URL: https://github.com/lucbpz/react-component-boilerplate
• Owner: lucbpz
• License: mit
• Created: 2019-10-23T17:58:55.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2019-10-23T18:05:43.000Z (about 5 years ago)
• Last Synced: 2024-11-08T04:39:25.629Z (2 months ago)
• Language: JavaScript
• Size: 5.86 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# React Component Boilerplate

This repo is a boilerplate for single React components that are developed individually. You can isolate a component, develop it in an agnostic way, test it and then export it as an NPM package to reuse it in other repositories.

This is perfect if you want to contribute to the open source React community by developing reusable React components.

Please, don't hesitate to open an issue or open a PR with improvements.

react-component-boilerplate uses

* Storybook

* Jest

* React-testing-library

* Webpack

## Developing the component

Run `npm test:dev` to make **Jest** watch all files.

Run `npm run storybook` to see the component in every state. You can tell **Storybook** to render every state of the component in *MyComponent.stories.js* file.

## Building the package

Run `npm run build` to make a *dist* folder with the exported component.

### Testing the packaged component

Once you have run `npm run build` you can link the component by doing `npm link` in the root of the project, and then doing `npm link react-component-boilerplate` in the root of the app where you want to test this packaged component.