gjungb / gortc Goto Github PK

The GoInstant GoRTC library glues together webrtc.js and GoInstant to offer audio/video conferencing with no server deployment or configuration. We use GoRTC as the base of our WebRTC widget.

• To use GoRTC, you can sign up for a free GoInstant account.

• Read the documentation on how GoRTC works.

• Check out our demo leveraging the GoRTC library for easy audio/video conferencing.

Have questions? Contact us using this form or chat with us on IRC. #goinstant on Freenode.

For your convenience, we've packaged the GoRTC widget in several ways.

We host a copy on our CDN. Have a look at the docs to see how to reference those files, as well as how to initialize the component.

You may have your own build process. We've tried to make it easy to include the GoRTC widget in your build process.

We've packaged the GoRTC widget as a bower component.

bower install goinstant-gortc

We've packaged the GoRTC widget as a component.

component install goinstant/gortc

• node.js >= 0.8.0
• grunt-cli installed globally
  • npm install -g grunt-cli

The following assumes that you have already installed the dependencies above.

git clone https://github.com/goinstant/gortc.git
cd gortc
npm install

The GoRTC widget is built as a component. Feel free to manually install dependencies and build using the component command line tool.

For convenience, we've included a simple grunt command for installing component dependencies and building:

grunt build

If this command runs succesfully you'll now have components and build directories in your Git repo root.

Tests are written in mocha. They're run in an HTML file.

Just open the test/index.html file to run the tests.

On Mac OS, you can just run this command to open the HTML Runner in your default browser:

open test/index.html

GoInstant is an API for integrating realtime, multi-user functionality into your app. You can check it out and sign up for free.

© 2013 GoInstant Inc., a salesforce.com company

Licensed under the BSD 3-clause license.