Skip to content

Latest commit

 

History

History
36 lines (25 loc) · 2.6 KB

README.md

File metadata and controls

36 lines (25 loc) · 2.6 KB
Raw

#kaazing-client-javascript

kaazing-client-javascript is a library containing several Javascript files necessary to develop a Javascript-based client for a Kaazing WebSocket Gateway. The file WebSocket.js is an implementation of the WebSocket specification [RFC-6455] (https://tools.ietf.org/html/rfc6455).

##Installing Dependencies 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.

##Steps to build the kaazing-client-javascript project Assumptions: node, npm, grunt and bower Command Line Interface(CLI) are already installed. The following steps will build the project and generate files in the ''dist'' directory.

  • Clone the repo: git clone https://github.com/kaazing/kaazing-client-javascript.git
  • Go to the cloned directory: cd kaazing-client-javascript
  • Command to install all the dependencies:npm install
  • Command to install project dependencies:bower 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.

##Directory structure

  • top-level files: package.json, GruntFile.js, bower.json, README.md, LICENSE.txt
  • src: Source files
  • test: Test files and karma config to run tests. Test can be run by using grunt karma commnd.
  • dist: A distribution directory will be generated which has js and jsdoc directories. During release the contents of this directory are released to https://github.com/kaazing/bower-kaazing-client-javascript.

##Notes