Easy HTML5 Server-Sent Events with JSON and HTTP
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
examples
lib
.gitignore
LICENSE
README.md
config.js

README.md

eventserver

Easy HTML(5) server-sent events with JSON and HTTP.

Status

Alpha

Overview

eventserver is an asynchronous, event-driven server for sending your HTML5 web pages events from your server as per the Server-Sent Events draft as implemented in several modern browsers. It is built on top of nodejs.

Installation

  1. Ensure you have nodejs 0.4.x
  2. Grab this project from github.
  3. Tweak config.js to your liking.
  4. Run bin/eventserver.

Usage

Once the server is up and running, it will be listening on two ports:

Port 4322 is the event port. Your server-side events clients should connect to this port and await for events to arrive as per the Server-Side Events spec.

Port 4321 is the JSON port. You send HTTP POST messages to this port containing a JSON Object, and the JSON message will in turn be broadcast to all clients connected to port 4322.

To see how you might use eventserver in your own HTML5 web apps, refer to the examples.

License

This software is available to you under the terms of the MIT License.

Support

Please log defects and feature requests using the github issue tracker.

About

eventserver was originally written by Tom Lee as an employee of Shine Technologies.

Follow me on Twitter, LinkedIn.

You might also be interested in reading Shine's Blog.