twilio-ip-messaging

ipmessaging-js-lib

Twilio IP Messaging helper library

Building

1. You will need Node build this repository
2. To build, you have two options:
3. build with make: run make - this will build the product using SDK-provided Makefile For the final product check the build folder
4. run npm install once and then build with Gulp: ./node_modules/gulp/bin/gulp.js As build result in the root directory will be produced in bin directory: twilio-ip-messaging.js

Releasing

Releasing how-to is available in RELEASE.md in this repository.

Unit & Integration Tests

Tests are using Mocha framework, Karma runner framework and PhantomJS2 headless server. To run tests just do gulp test. Karma test debugging and test server are supported. Currently the default browser for debugging is Chrome. To run test server do gulp testserver.

Documentation

Documentation is generated using JSDoc. This is automatically done during the build.

Linting

Linting is provided by ESLint. The build will fail if there is a lint issue to prevent dumb mistakes.

Private Methods & Variables

"Private" methods & variables are prefixed with an underscore to indicate that they should not be used.

Importing Gulp's Version

Copy /bin/twilio-ipmessaging-js/twilio-ip-messaging.js to your webpage directory and include it as so:

<script type="text/javascript" src="/twilio-ip-messaging.js"></script>