- sample boilerplate for using React with Rollup
-
Install (yarn or npm)
Yarn:
$ yarn add puppy-components-woof
NPM:
$ npm install puppy-components-woof
-
Import the component(s) you want to use. Visit the playground for usage examples and component docs.
To start the developing run :
> npm run dev
Testing is done with Jest, Enzyme and Jasmine Matchers
> npm run test
or (for getting coverage)
> npm run test:coverage
Linting is set up through ESLint and configured with eslint-config-airbnb
You can modify linting rules by overriding them in the .eslintrc.json
file.
> npm run lint
or (for for automatic fixing if possible)
> npm run lint:fix
> npm run release
Make sure the repository url in package.json
file is set to your repoitory url, then:
> npm run deploy
-
npm run dev
: Executes the develop mode, running watcher and the Stylguide, rebuilding your library on every change. -
npm run start
: Only serves the Styleguide. -
npm run build
: Builds your library (build can be faound indist
folder). -
npm run styleguide:build
: Builds the static Styleguide in case you want to deploy it. -
npm run test
: Runs the tests. -
npm run test:coverage
: Runs the test and shows the coverage. -
npm run lint
: Runs the linter. -
npm run lint:fix
: Runs the linter and fixes automatic fixable issues. -
npm run release
: Publishes your Library on NPM or your private Registry (depending on your config in your.npmrc
file). -
npm run deploy
: Deploys the Styleguide to GitHub Pages.