The gateway (WebSocket) project implements the WebSocket standard in JavaScript. It provides a WebSocket client API that enables developers to build JavaScript applications that communicate to a back-end service over WebSocket via an RFC-6455 endpoint, such as KAAZING Gateway.
Before building kaazing-client-javascript, please install and configure the following dependencies:
- Git: The Github Guide to Installing Git is a good source of information.
- Node.js: Node is used to install necessary dependancies. Depending on your system, you can install Node either from source or as a pre-packaged bundle.
- Bower: Bower is used to manage project dependancies. Install the bower command-line tool globally with:
npm install -g bower - Grunt: Grunt is used to build kaazing-client-javascript, generate the documentation and run tests. Install the grunt command-line tool globally with:
npm install -g grunt-cli
Note: These may need elevated privileges requiring the use of either sudo (for OSX, *nix, BSD etc) or running the command shell as an Administrator (for Windows) to install Grunt & Bower globally.
- Clone the repo:
git clone https://github.com/kaazing/javascript.client.git - Go to the cloned directory:
cd javascript.client - Command to install all the dependencies:
npm install - Command to run the configured tasks:
grunt
Note: These may need elevated privileges requiring the use of either sudo (for OSX, *nix, BSD etc) or running the command shell as an Administrator (for Windows) to install Grunt & Bower globally.
You can use an RFC-6455 endpoint, such as KAAZING Gateway, to connect to a back-end service. To learn how to administer the Gateway, its configuration files, and security, see the documentation on developer.kaazing.com.
To learn how to develop client applications with this project, see the documentation on developer.kaazing.com.
To view demos of clients built with this project, see kaazing.org