| 1 | ## Prerequisites
|
| 2 |
|
| 3 | [Node.js](http://nodejs.org/) >= 6 must be installed.
|
| 4 |
|
| 5 | ## Installation
|
| 6 |
|
| 7 | - Running `npm install` in the component's root directory will install everything you need for development.
|
| 8 |
|
| 9 | ## Demo Development Server
|
| 10 |
|
| 11 | - `npm start` will run a development server with the component's demo app at [http://localhost:3000](http://localhost:3000) with hot module reloading.
|
| 12 |
|
| 13 | ## Running Tests
|
| 14 |
|
| 15 | - `npm test` will run the tests once.
|
| 16 |
|
| 17 | - `npm run test:coverage` will run the tests and produce a coverage report
|
| 18 |
|
| 19 | - `npm run test:watch` will run the tests on every change.
|
| 20 |
|
| 21 | - `npm run test:coverage-watch` will run tests on every change and produce a coverage report
|
| 22 |
|
| 23 | ## Building
|
| 24 |
|
| 25 | - `npm run build` will build the component for publishing to npm (generating \lib, \es, and \umd directories) and also bundle the demo app.
|
| 26 |
|
| 27 | - `npm run clean` will delete built resources.
|