Coder Social home page Coder Social logo

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.

Respoke's Projects

androidasync icon androidasync

Asynchronous socket, http (client+server), websocket, and socket.io library for android. Based on nio, not threads.

apollo icon apollo

IM, group chat, and video calls built on Respoke

chan_respoke-docker icon chan_respoke-docker

Dockerfile for building a working Asterisk installation with the chan_respoke channel driver

hackathon icon hackathon

General landing page for Respoke sponsored hackathons

lahacks icon lahacks

Landing page for LA Hacks Hackathon

node-respoke-admin icon node-respoke-admin

This is the Node.js library that wraps the HTTP and WebSocket API provided by Respoke.

pjsip-docker icon pjsip-docker

DEPRECATED: Dockerfile for building pjsip as a base for asterisk & chan_respoke

respoke icon respoke

Respoke JavaScript Browser/Client Library

respoke-dist icon respoke-dist

Pre-built versions of Respoke.js to support some package managers like Bower.io

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.