SkywayJS

SkywayJS is an open-source client-side library for your web-browser that enables any website to easily leverage the capabilities of WebRTC and its direct data streaming powers between peers for audio/video conferencing or file transfer.

You'll need a Temasys Developer Account and an API key to use this. Register here to get your API key.

We've gone to great length to make this library work in as many browsers as possible. SkywayJS is build on top of AdapterJS and works with our Temasys WebRTC Plugin even in Internet Explorer and Safari on Mac and PC.

• Getting started
• SkywayJS API Docs
• Introducing SkywayJS
• Developer Console - Get your API key

Need help or want something changed?

Please read how you can find help, contribute and support us advancing SkywayJS on our Github Page.

How to setup this project

• Install or update to the latest version of node and npm
• Install grunt-cli (See: http://gruntjs.com/getting-started)
• Run npm install to install dev dependencies.
• Run npm install -g browserify and npm install -g testling (might require sudo) to install the necessary tools to test locally
• Run npm start to start a local webserver to be able access the demo and doc folders (WebRTC won't work from your local file-system). This will popup Chrome (Mac). You can configure a different browsers in the start.sh file.

Development

• Run npm test to execute jshint and run the tests in your local Chrome (Mac). You can configure this in the test.sh file.
• Run grunt jshint to run jshint on its own.
• Run grunt publish to create production version in publish folder and generate the documentation in doc folder

What's included?

demo

Some demos to help with the development

doc

YUI documentation for the Skyway object and its events

doc-style

Template for our YUI documentation

publish

The production version of the library and a minified copy of it

source

The skyway.js library development files

tests

• Run test.sh <type> <param> to test the trigger events of SkywayJS.
• To run a test, simply type: test.sh test webrtc
• To run a bot (that some tests requires), simply type: test.sh bot webrtc
• Note that in some instances, if the test requires a bot, always run the bot first before running the test.

License

APACHE 2.0