Skip to content

Latest commit

 

History

History
167 lines (112 loc) · 5.22 KB

README.md

File metadata and controls

167 lines (112 loc) · 5.22 KB
Raw

express.io

realtime-web framework for node.js

express.io = express + socket.io

Simple App Setup

Here is the canonical express.io example.

app = require('express.io')()
app.http().io()

//build your realtime-web app

app.listen(7076)

Upgrade your existing Express apps

First install:

npm install express.io

Then, simply replace this line of code

require('express')

with this line of code

require('express.io')

Your app should run just the same as before! Express.io is designed to be a superset of Express and Socket.io. An easy to use drop-in replacement that makes it simple to get started with the realtime-web.

Realtime Routing is Sweet

With express.io you can do realtime routing like a pro.

app.io.route('customers', {
    create: function(req) {
        // create your customer
    },
    update: function(req) {
        // update your customer
    },
    remove: function(req) {
        // remove your customer
    },
});

And then on the client you would emit these events:

  • customers:create
  • customers:update
  • customers:delete

Or do it the old fashioned way:

app.io.route('my-realtime-route', function(req) {
    // respond to the event
});

Automatic Session Support

Sessions work automatically, just set them up like normal using express.

app.use(express.session({secret: 'express.io makes me happy'}));

Double Up - Forward Normal Http Routes to Realtime Routes

It's easy to forward regular http routes to your realtime routes.

app.get('/', function(req, res) {
    req.io.route('some-cool-realtime-route');
});

Examples

All of these examples work. I repeat, they all work. Express.io is a very simple framework that allows you to build incredibly complex realtime apps with very little code.

All Examples

Or view them bite size:

To run the examples from git, do the following:

git clone https://github.com/techpines/express.io
cd express.io/examples
npm install

Then you'll be ready to run the example code with a simple:

node app.js

API Reference

This should help you get a birds eye view of the express.io architecture. Simple and lean. Reuse your express and socket.io knowledge.

API Reference

Here are all the wonderful express.io objects!

FAQ

Have frequent questions, we have frequent answers.

Check here.

Test

We have a full test suite. We also run the full express test suite to ensure compatibility.

cd express.io
npm test

License

It's free! Party with the MIT!

Copyright (c) 2012 Tech Pines LLC, Brad Carleton

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.