Skip to content

Latest commit

 

History

History
88 lines (60 loc) · 2.48 KB

README.md

File metadata and controls

88 lines (60 loc) · 2.48 KB
Raw

Digium Respoke Example Apps

These are a suite of example applications to show how to work with the Respoke API just using jQuery.

Getting Started

The fastest way to try out the web-examples is to view them live!

Alternatively you can run the already built files from the web server of your choice as they are static HTML files. Point your web server to the app directory or copy the files there to an already publicly accessible location.

See the Development section for details on how to use Node.js to run the examples.

Group Messaging

For more details on how to setup and use the group messaging example please see the README in that module.

Screen Sharing

At this time, screen sharing is only available in Chrome. Support for other browsers will be added in the future. Please check the screen sharing documentation for browser support details or live examples to test it out.

Development

You will need to install Node.js, npm, and Bower to build the JavaScript and CSS. After installing npm and Bower, install the dependencies.

npm install; bower install;

To build the JavaScript, CSS, and HTML:

grunt build

To run the built-in Node.js server with file watching and a test runner:

grunt server

Once the server starts, you can see all of the apps by visiting http://localhost:9876.

It will also fire up an ngrok tunnel for doing HTTPS, which is useful during a screenshare. Look for the following terminal output:

Visit the following url to run the examples over HTTPS.
https://423e076.ngrok.com
They are also running locally.
http://localhost:9876

If you have push access to the respoke/web-examples repo you can update the live examples with:

grunt publish

Testing

The tests are written using mocha. After going through the setup in the Development section, just run the grunt test task. This will build the necessary files and run the jshint linter and mocha.

grunt test

License

The code in this package uses the MIT license. See the LICENSE file for more details.