https://github.com/respoke/web-examples
Examples of using Respoke in the browser
https://github.com/respoke/web-examples
Last synced: about 1 year ago
JSON representation
Examples of using Respoke in the browser
- Host: GitHub
- URL: https://github.com/respoke/web-examples
- Owner: respoke
- License: other
- Created: 2014-10-17T13:29:00.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2015-09-14T16:30:12.000Z (almost 11 years ago)
- Last Synced: 2025-03-25T08:38:14.986Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://respoke.github.io/web-examples/
- Size: 46.3 MB
- Stars: 6
- Watchers: 10
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Digium Respoke Example Apps
These are a suite of example applications to show how to work with the
[Respoke](https://docs.respoke.io/) API just using jQuery.
### Getting Started
The fastest way to try out the web-examples is to [view them live][examples]!
[examples]: https://respoke.github.io/web-examples "view examples"
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](app/modules/group-messaging/README.md) 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](https://docs.respoke.io/js-library/respoke.Endpoint.html#startScreenShare)
for browser support details
or [live examples](https://respoke.github.io/web-examples/modules/screen-sharing/index.html) to test it out.
### Development
You will need to install [Node.js](http://nodejs.org),
[npm](https://www.npmjs.org), and [Bower](http://bower.io) to build the
JavaScript and CSS. After installing npm and Bower, install the dependencies.
```bash
npm install; bower install;
```
To build the JavaScript, CSS, and HTML:
```bash
grunt build
```
To run the built-in Node.js server with file watching and a test runner:
```bash
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:
```bash
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][examples] with:
```bash
grunt publish
```
### Testing
The tests are written using [mocha](http://mochajs.org). 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](http://jshint.com/docs/) linter and mocha.
```bash
grunt test
```
### License
The code in this package uses the MIT license. See the [LICENSE](LICENSE) file for more
details.