bclubb / gortc

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

Home Page:http://goinstant.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Build Status

GoRTC Library

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.

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

Packaging

For your convenience, we've packaged the GoRTC 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 GoRTC widget in your build process.

Bower

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

bower install goinstant-gortc

Component

We've packaged the GoRTC widget as a component.

component install goinstant/gortc

Contributing

Development Dependencies

Set-Up

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

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

Building GoRTC for Development

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.

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

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

© 2013 GoInstant Inc., a salesforce.com company

Licensed under the BSD 3-clause license.

About

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

http://goinstant.com

License:BSD 3-Clause "New" or "Revised" License