1.0.0 • Published 4 years ago

@nestagencyuk/react-components v1.0.0

Weekly downloads
-
License
ISC
Repository
github
Last release
4 years ago

Nest React Components

Usage:

Usage is outlined in our Documentation

Contribution:

Develop

Bundles all components using Storybook, starts the dev server and watches for changes.

$ npm run dev

Scaffold

You can quickly scaffold a new component by running:

$ NAME=MyNewComponent npm run scaffold

OR

$ NAME=MyNewComponent npm run scaffold:stateful

This will create a new stateless (functional) or stateful (using hooks) component folder with all the required files and some example variants. This is the best way of ensuring a new component complies with our coding standards and naming conventions.

Build

Bundles everything using webpack and outputs to /dist/ ready to be republished to npm.

$ npm run build

Run individual tasks:

CommandDescription
$ npm run build:componentsBuild just the components
$ npm run build:docsBuild just storybook documentation

Testing

Run all tests:

$ npm run test

Run individual tests:

CommandDescription
$ npm run test:cypressRun automated browser tests
$ npm run test:unitRun component unit tests
$ npm run test:coverageRun coverage tests and send coverage report