Skip to content

joelhenriquedev/boilerplate-react-library

Repository files navigation

react boilerplate banner


Create react components quickly with the boilerplate, zero configuration.
Everything you need to build React components


Created by Joel Henrique

Features

  • Transpiles all modern JS features
  • Jest for testing
  • Babel for transpilation
  • Support SASS
  • Support Travis CI
  • Rollup for build proces
  • Bundles cjs and es module formats
  • Support Typescript
  • Server local for development
  • Support StoryBook

Quick start

Common Tasks

  • Developing - go to the example folder and use the npm run server command

  • Building- npm run build - Will create the build in the dist folder

  • Creating a version - npm version <x.y.z>.

  • Publishing a version - npm publish - Pushes a new version to npm and updates the project site.

Testing

The test setup is based on Jest. Code coverage report is generated to coverage/. The coverage information is also uploaded to codecov.io after a successful Travis build.

StoryBook documentation

The documentation was made using Storybook, the configuration folder is .storybook /. Create a ***. Stories.js file inside src /. More informations

  • Running documentation - npm run storybook
  • Running tests once - npm test

Keywords: React.js, Library, Boilerplate, Module, Babel, React Component Library, Rollup, Component, , Jest, Sass, Storybook, Typescript

License

This project is licensed under the MIT license, Copyright (c) 2020 Joel Henrique Silva Santos. For more information see LICENSE.md.