sanjay-saxena / kaazing-amqp-0-9-1-client-javascript Goto Github PK

#kaazing-amqp-0-9-1-client-javascript

This repository contains the source code for the Amqp-0-9-1.js library for running AMQP 0-9-1 Javascript clients over WebSocket. Using the library, you will be able to send and receive AMQP messages from within a browser and communicate with an AMQP 0-9-1 compliant message broker such as Apache Qpid or Pivotal RabbitMQ by way of the Kaazing Gateway AMQP Proxy service.

You can find pre-built versions of all the amqp-0-9-1.js build artifacts (the client library, demo page and jsdoc files) in the github bower-kaazing-amqp-0-9-1-client-javascript repository.

##Installing Dependencies Being a Github-based Javascript project, kaazing-amqp-0-9-1-client-javascript follows the common javascript-project tool chain, using git, node.js (npm), bower and grunt to generate the amqp-0-9-1.js distribution file and documentation and run tests. If you're new to the javascript-project tool chain, check out the following links for more details:

• Git: The Github Guide to Installing Git is a good source of information.
• Node.js: Node(npm) is used to install necessary build dependencies such as grunt plugins. Depending on your system, you can install Node either from source or as a pre-packaged bundle.
• Bower: Bower is used to manage necessary project dependencies. Install the bower command-line tool globally with: npm install -g bower
• Grunt: Grunt and its plugins are used to build the project artifacts (Amqp-0-9-1.js and documentation files) and to 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.

##Directory structure The repository is made up of the following files and directories:

• base-directory files:
  • package.json - the control file used by npm to install build dependencies
  • bower.json - the control file used by bower to install project dependencies
  • Gruntfile.js - the control file used by grunt to build the project and run tests
  • README.md - the file describing the project
  • LICENSE.txt - the project's Apache 2.0 license
• src: Source files for the javascript library
• demo: Demo files
• test: Test files and karma configuration to run tests. Test can be run by using grunt karma commnd.
• dist: The directory of distribution artifacts, built with grunt. It contains:
  • javascript: The complete demo package, including the generated Amqp-0-9-1.js library, the amqp.html demo file, and resources and images sub-directories.
  • jsdoc: API documentation generated from the Amqp-0-9-1.js file.

##Building the project Once you've installed git and node (npm) globally, you can download the project and build the distribution artifacts with the following steps:

• Clone the repository: git clone https://github.com/kaazing/amqp-0-9-1-client-javascript.git
• Go to the cloned directory: cd amqp-0-9-1-client-javascript
• Install the build dependencies:npm install
• Install project dependencies:bower install
• Run the build 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.

##Notes

• The Amqp-0-9-1.js library will not work with the WebSocket implementation available in Android's stock(default) browser. To make it work with the Android stock(default) browser, please use Amqp-0-9-1.js with Kaazing's WebSocket.js.
• Files in the "dist" subdirectory are regenerated each time you build the project with grunt. Changes to those files are not saved! If you want to change source files, look in the src directory.