ReevooPing: JavaScript Client

reevoo-ping.js is a JavaScript client that allows events to be sent to Reevoo. This is fed into our Analytics tools for analysis.

The User Guide details how to set up ReevooPing with custom implementations.

Development

Grab nodenv and go:

nodenv install
npm install

You should be ready to go! Check by running the tests:

npm test

:zap: :zap: DEV MODE :zap: :zap:

Run this to :zap: :zap: ENTER DEV MODE: :zap: :zap:

npm run watch

In Dev Mode:

• A server will be started to the demo server at http://localhost:8080. This will live reload on lib changes.
• The specs will be run on every lib or spec change.
• Webpack will bundle on every lib change.

For more information on the tasks you can do, check out package.json.

Troubleshooting

Sometimes when running Dev Mode, you can encounter:

> webpack -d --watch
events.js:141
throw er; // Unhandled 'error' event
      ^

Error: listen EADDRINUSE 127.0.0.1:8080
...

The test server isn't very good at shutting itself down correctly. Use killall node to get rid of any stray Node.JS instances and restart Dev Mode.

Creating New Events

1. Tell Snowplow about the event. To do this, add your event to the Reevoo Event Dictionary. (Instructions are in the README there.)
2. Add the event and specs to this repository.
3. Update the version number in accordance with Semantic Versioning. (Hint: A new event is likely to be a minor version bump.) Tag the commit.

Building

Ready to go? Then build for production!

npm run build:prod

This will build a production-ready file and place it in the dist folder. (Do not commit this!)

Deployment

TODO: Write deployment instructions!