search

aullman / opentok-meet

Opentok app with screen sharing using the WebRTC screen sharing feature
MIT License
133 stars 129 forks source link

readme

Build Status Code Climate Test Coverage

opentok-meet

Opentok app with screen sharing using the WebRTC screen sharing and Archiving features. You can check it out running at meet.tokbox.com.

Mobile Applications

There are a few different mobile applications that have been built to interoperate with this application.

Running locally

  1. If you haven't already, sign up for OpenTok.
  2. Clone this repo
  3. cp config.json.sample config.json
  4. Add your OpenTok apikey and secret to config.json
  5. Create your screensharing extensions by following the instructions at https://github.com/opentok/screensharing-extensions and put your Chrome Extension ID in config.json.
  6. Run redis. You can find instructions for doing this here.
  7. yarn (you will need at least 1GB memory for this step)
  8. If you want to use SSL you will need to generate a key and make sure the server.key and server.crt files are in the main directory. You can find instructions for generating a self-signed certificate here. SSL is recommended so that screen-sharing works and so that you don't have to keep clicking the allow button to allow access to your camera. If you still don't want to use SSL then just update app.js to use http.createServer instead of https.createServer.
  9. npm start
  10. Go to https://localhost:3000

Running on Heroku

  1. If you haven't already, sign up for OpenTok.
  2. Create a Heroku instance
  3. Clone this repo
  4. In the repo run heroku git:remote -a <instance name> to add the remote to github.
  5. Add redistogo heroku addons:add redistogo
  6. Add your OpenTok API Key and Secret and your Chrome Screensharing Extension ID to the environment heroku config:set HEROKU=true OT_API_KEY=<YOUR_API_KEY> OT_API_SECRET=<YOUR_SECRET> CHROME_EXTENSION_ID=<YOUR_EXTENSION_ID>
  7. git push heroku master
  8. Visit your heroku URL

Running Tests

You can run the unit tests using npm test. This command is setup to work correctly in the Travis CI system as well as when running locally. But if you want it to run locally you need to setup a few things. You will need to sign up for Sauce Labs. This service offers free options for Open Source. You will need the following environment variables set.

export SAUCE_USERNAME=<YOUR_SAUCE_USERNAME>
export SAUCE_ACCESS_KEY=<YOUR_SAUCE_KEY>
export TRAVIS_JOB_NUMBER=<ANYTHING>

By default npm test will run the tests in Chrome Stable. If you want to run in different environments you can set the BROWSER and BVER environment variables. eg. export BROWSER=ie BVER=11;npm test. Supported combinations are:

These tests are also run in the cloud with every commit and every pull request using Travis-CI and Sauce Labs.