Notifications JS Client

JavaScript client library wrapping the mnd-notifications backend API and providing an interval based polling mechanism to listen for new notifications.

Build

rollup is used to build the js library. To run the build use:

yarn build

Development

For development you can run:

yarn start

This will start a development server which serves a test page at http://localhost:10001.

You can use this to test local changes, assuming you have the mnd-notifications backend running at http://mnd-notifications.test. The index.html file used for the server can be found in public

Releasing

• use lerna publish in the parent folder

Testing

• to run the tests use:

yarn test

• to rerun test when saving run:

yarn test --watch

• coverage reports can be shown with:

yarn coverage

Documentation

• class and method documentation can be found in api.md
• to generate the documentation from source run:

yarn doc:build

• to see the documentation while developing run (documention will be serverd at http://localhost:4001):

yarn doc:serve

Related links

• rollup
• documentation system