ankitsny / webrtc

This repo will no longer be updated. GoInstant will be discontinued as of August 31, 2014. Read our blog for more details.

WebRTC Widget

The GoInstant WebRTC widget provides a drop-in, back-end free, video conferencing solution. is makes it incredibly easy to get started with WebRTC in your application.

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

• Read the documentation on how WebRTC works.

• Check out our demo leveraging the WebRTC widget for easy audio/video conferencing.

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

Packaging

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

Using our CDN

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.

How do I build the script myself?

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

Bower

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

bower install goinstant-webrtc

Component

We've packaged the WebRTC widget as a component.

component install goinstant/webrtc

Contributing

Development Dependencies

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

Set-Up

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

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

Building WebRTC for Development

The WebRTC 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.

Running Tests

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

Running Examples

This will open up an example of WebRTC at work, using your local build.

You should have run grunt build already.

1. Copy the example config.

cp config/config.example.js config/config.js

2. Replace the connectUrl with your GoInstant application's connectUrl.

If you haven't signed up for GoInstant yet, you can sign up and create an application here.

After you have an application's connectUrl, set inside of config.js:

config.js

window.config = {
  connectUrl: 'https://goinstant.net/YOUR_ACCOUNT/YOUR_APP',
  room: 'goinstant-widget-examples'
};

3. Open the example index and click an example.

open examples/index.html

Widgets are built on top of GoInstant

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

License

© 2014 GoInstant Inc., a salesforce.com company

Licensed under the BSD 3-clause license.