Respoke JavaScript Browser/Client Library
JavaScript HTML Other
Latest commit a299195 Jan 18, 2016 @chadxz chadxz 2.1.1
Permalink
Failed to load latest commit information.
githooks New readme; comply with jshint. Nov 14, 2014
plugins/respoke-stats Clean up of the minified file Jul 15, 2015
respoke Set internal call events to internal so end user may not remove them. Jan 18, 2016
scripts Fix automatic changelog versioning Jan 18, 2016
spec Fix renegotiation for same browser aud/vid calling Dec 18, 2015
.editorconfig adding editorconfig Mar 27, 2015
.gitignore Exposed internals of signaling channel to make more testable. Exposed… Oct 22, 2015
.jscsrc Generate unminified distributable, fix source-maps Oct 13, 2015
.jshintignore Generate unminified distributable, fix source-maps Oct 13, 2015
.jshintrc Cleanup and refactor to prepare for renegotiation Dec 18, 2015
.jshintreporter.js fixed comments in jshint reporter Nov 18, 2014
CHANGELOG.md 2.1.1 Jan 18, 2016
Gruntfile.js Cleanup mapfile name for stats library Jan 15, 2016
LICENSE Updated dev dependencies to work with node v4. MER-4511 Dec 15, 2015
README.md Updated dev dependencies to work with node v4. MER-4511 Dec 15, 2015
docs.jade Upgrade jsdoxy again, and fix some things in the template for display… May 14, 2015
docs.scss apply new mockup styles to docs Mar 10, 2015
index.js refactored main respoke library to commonJS. Jun 24, 2014
npm-shrinkwrap.json 2.1.1 Jan 18, 2016
package.json 2.1.1 Jan 18, 2016
webpack.config.js Generate unminified distributable, fix source-maps Oct 13, 2015
webpack.dist.js fix build of unminified assets Oct 13, 2015

README.md

Respoke.js

Browser/Client Library for Respoke. Use this library in a JavaScript web app to add individual and group messaging, contact discovery, and voice and video calling to web apps.

Usage

NPM

npm install respoke

then

require('respoke');

CDN

Grab a release from the CDN:

Prebuilt / Bower

bower install --save respoke

Prebuilt and minified versions of respoke.js can be found at github.com/respoke/respoke-dist.

Documentation

The documentation for this library resides on the Respoke website. Also check out the quickstart guide and other tutorials.

Development Dependencies

We welcome discussion on our community and contributions from the community. To get started contributing back, you'll need to clone this repo and run the following commands.

brew install node
# or
# apt-get install nodejs
npm install -g grunt
npm install

Tests

There are two different types of tests within transporter.

  1. Unit tests. These run locally and have no dependencies on external systems.
  2. Functional tests. These require an account with Respoke in order to run

Unit tests

These can be run simply using grunt.

grunt unit

Functional tests

In order to run the functional tests, go to https://respoke.io and sign up for an account, and create an application. You then configure spec/test-config.json with your account and application credentials.

{
    "appId": "",
    "appSecret": "",
    "username": "",
    "password": ""
}

Compilation

Respoke.js uses CommonJS to manage its dependencies, and the Webpack module bundler to bundle the library. To create the bundled and minified library suitable for distribution, you can run

grunt dist

or

webpack && npm run build-stats

If you want to have the source files watched and built automatically when changes are made, run

webpack --watch

If you want the watch task to rebuild faster, you can comment out the uglify plugin in webpack.config.js for the duration of your development.

Code Compliance

This project uses jshint. The configuration for jshint can be found in the repo at .jshintrc and .jshintignore.

npm run jshint

Point your editor to .jscsrc to follow the project's JavaScript Code Style (JSCS) rules.

npm run jscs

License

Respoke.js is licensed under the MIT license.