React Rollup Boilerplate

A boilerplate for building React libraries

Included

• Rollup with Babel, SCSS and other plugins:
  • Node Resolve
  • CommonJS
• Test runner: Jest
• Code Coverage reporter: Codecov
• Enzyme test framework
• ES Linting: ESLint using AirBnb style guide for library sources
• Example from official Rollup tutorial
• Demo project with create-react-app

Setup

Install the latest Node JS and Yarn and simply run yarn or yarn install command in the root project directory and in demo/.

Local development

During development, run:

yarn start # watches and builds new code changes

Static Types

yarn flow # performs type checking on files

See official documentation for a usage guide.

Yarn will run postinstall for updating flowtype definitions when new packages are added.

Lint

yarn lint # runs linter to detect any style issues
yarn lint --fix # tries to fix lint issues

Test

yarn test # runs functional/unit tests using Jest
yarn test --coverage # with coverage

Build

yarn build

Demo App Development

npm link
cd demo/
yarn # install dependencies
yarn start # watch, build, and serve the demo app on localhost:3000

Review demo/README.md for more information.