Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
The goal of this project is to make XMPP really simple to use for developers. This module takes away all of the XML and works by hooking to events which are passed between client and server using a transport in JSON. For example code see https://github.com/lloydwatkin/xmpp-ftw-demo.
JavaScript Other

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
examples
lib
test
.gitignore
.travis.yml
LICENSE
README.md
index.js
package.json

README.md

XMPP-FTW (For The Web/Win)

The goal of this project is to make XMPP really simple to use for developers. This module takes away all of the XML and works by hooking to events which are passed between client and server using a transport in JSON. In the example code we use socket.io, but there is no reason this can not be replaced with engine.io, or implement your own transport and pass in as a connection.

Try it out...

The code is now up and running at https://xmpp-ftw.jit.su so you can try it out. Be aware that this setup is only for trying xmpp-ftw out and may be slow as we need to go client->nodejitsu->your XMPP server and back each time.

The version running on the website matches 'master' branch here and auto-deploys with commits.

Blog posts/Talks

Build status

Build Status

  • npm i xmpp-ftw
  • Create your socket.io connection manually and then pass this socket into the constructor
io.sockets.on('connection', function(socket) {
     new require('xmpp-ftw').Xmpp(socket);       
});
  • All events are prefixed with 'xmpp.'

For an example of usage and a breakdown of commands simply install the development dependencies and run the index.js file the examples directory.

  • git clone https://github.com/lloydwatkin/xmpp-ftw
  • npm i .
  • npm run-script develop
  • Go to http://localhost:3000
  • See instructions on the page

Alternatively have a look at the demo client:

  • npm run-script develop
  • Go to http://localhost:3000/demo

To work on the code in 'development mode' (where process restarts as files change) run npm run-script develop.

License

License is Apache 2.0, please let me know if this doesn't suit.

Something went wrong with that request. Please try again.