diff options
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..dd641ce --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,27 @@ +## Prerequisites + +[Node.js](http://nodejs.org/) >= 6 must be installed. + +## Installation + +- Running `npm install` in the app's root directory will install everything you need for development. + +## Development Server + +- `npm start` will run the app's development server at [http://localhost:3000](http://localhost:3000) with hot module reloading. + +## Running Tests + +- `npm test` will run the tests once. + +- `npm run test:coverage` will run the tests and produce a coverage report in `coverage/`. + +- `npm run test:watch` will run the tests on every change. + +## Building + +- `npm run build` creates a production build by default. + + To create a development build, set the `NODE_ENV` environment variable to `development` while running this command. + +- `npm run clean` will delete built resources. |