/stomp-websocket

Stomp Client using HTML5 Web Sockets API

Primary LanguageJavaScriptApache License 2.0Apache-2.0

STOMP 0ver WebSocket

The library file is located in dist/stomp.js. It does not require any dependency (except WebSocket support from the browser or an alternative to WebSocket!)

Online documentation describes the library API.

Development Requirements

For development (testing, building) the project requires Node.js, CoffeeScript, and Jasmine. This allows us to run tests without the browser continuously during development (see cake watch).

  • Node.js and NPM
  • NPM packages
    • coffee-script
    • jasmine-node
    • growl (optional)

Building and Testing

Build Status

To build JavaScript:

cake build

To run tests:

cake test

To continuously run tests on file changes:

cake watch

Browser Tests

  • Make sure you have a running STOMP broker which supports the WebSocket protocol (see the documentation)
  • Open in your web browser the project's test page
  • Check all tests pass

Use

The project contains an chat example using stomp.js to send and receive Stomp messages from a server.

Authors