![express.io](http://cdn.techpines.io/express.io-black.png)

realtime-web framework for node.js

```coffeescript
express.io = express + socket.io
```

## Simple App Setup

Here is the canonical express.io example.

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

//build your realtime-web app

app.listen(7076)
```

## Upgrade your existing Express apps

First install:

```bash
npm install express.io
```

Then, simply replace this line of code

```javascript
require('express')
```

with this line of code

```javascript
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.

```js
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:

```js
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.

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

**Please note** that the SocketIO session support is given by using the SocketIO authorization handler. Thus, if there 
is a need to implement your own authorization it needs to populate the session similar to the default authorization
handler provided by Express.IO

Here is a small example of a custom handler

```js
//use passport to authenticate our socket.io connections
  //  NOTICE: to keep this working with express.io we must expose the session ourselves
  app.io.set("authorization",function(data,accept){
    var cookieParser = express.cookieParser(app.config.get("session.secret"))
      , req = {headers:{cookie:data.headers.cookie}}
      , session_id
    cookieParser(req,{},function(err){
      if(err) throw err
      session_id = req.signedCookies[app.config.get("session.key")]
      session_store.get(session_id,function(err,session){
        if(err) throw err
        //THIS SETS THE SESSION FOR EXPRESS.IO TO WORK
        var connect = require("../node_modules/express.io/node_modules/express/node_modules/connect")
        data.sessionID = session_id
        data.session = new connect.session.Session(data,session)
        //now validate our request
        if(!session[passport._key][passport._userProperty] && !data.headers.referer.match(/login/)) accept(null,false)
        else accept(null,true)
      })
    })
  })
```

## Double Up - Forward Normal Http Routes to Realtime Routes

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

```js
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](https://github.com/techpines/express.io/tree/master/examples#readme)

Or view them bite size:

* [Simple HTTP + IO Setup](https://github.com/techpines/express.io/tree/master/examples#simple-http--io-setup)
* [Simple HTTPS + IO Setup](https://github.com/techpines/express.io/tree/master/examples#simple-https--io-setup)
* [Routing](https://github.com/techpines/express.io/tree/master/examples#routing)
* [Route Forwarding](https://github.com/techpines/express.io/tree/master/examples#route-forwarding)
* [Broadcasting](https://github.com/techpines/express.io/tree/master/examples#broadcasting)
* [Sessions](https://github.com/techpines/express.io/tree/master/examples#sessions)
* [Rooms](https://github.com/techpines/express.io/tree/master/examples#rooms)
* [Acknowledgements](https://github.com/techpines/express.io/tree/master/examples#acknowledgements)
* [Realtime Canvas](https://github.com/techpines/express.io/tree/master/examples#realtime-canvas)
* [Scaling with Redis](https://github.com/techpines/express.io/tree/master/examples#scaling-with-redis)

To run the examples from git, do the following:

```js
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](https://github.com/techpines/express.io/tree/master/lib#readme)

Here are all the wonderful __express.io__ objects!

* [ExpressIO](https://github.com/techpines/express.io/tree/master/lib#expressio)
* [ExpressApp](https://github.com/techpines/express.io/tree/master/lib#expressapp)
* [AppIO](https://github.com/techpines/express.io/tree/master/lib#appio)
* [SocketRequest](https://github.com/techpines/express.io/tree/master/lib#socketrequest)
* [RequestIO](https://github.com/techpines/express.io/tree/master/lib#requestio)

## FAQ

Have frequent questions, we have frequent answers.

[Check here](https://github.com/techpines/express.io/tree/master/docs/faq.md).

## Test

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

```bash
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.
