Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
33 lines (19 loc) · 933 Bytes

CONTRIBUTING.md

File metadata and controls

33 lines (19 loc) · 933 Bytes

Prerequisites

Node.js >= v4 must be installed.

Installation

  • Running yarn in the component's root directory will install everything you need for development.

Demo Development Server

  • npm start will run a development server with the component's demo app at http://localhost:3000 with hot module reloading.

Storybook

  1. copy devToken.js.rename to devToken.js
  2. add a valid token from apple to devToken.js
  3. run yarn storybook
  4. visit the URL storybook gives you
  5. play with maps!

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 will build the component for publishing to npm and also bundle the demo app.

  • npm run clean will delete built resources.