Skip to content
This repository

A fast, modular Node.js web framework dedicated to building realtime single-page apps

Merge pull request #437 from malditogeek/fix-gitter-badge

chore(README): Fix Gitter badge URL
latest commit 86afc6679c
RomanMinkin RomanMinkin authored
Octocat-spinner-32 bin Different CSS formatters support January 28, 2014
Octocat-spinner-32 docs make console.log the default, include docs-setup.js generated changes February 10, 2014
Octocat-spinner-32 lib Remove file extensions from browserify module February 25, 2014
Octocat-spinner-32 misc refactor(Gruntfile): refactor for `grunt before-test` task January 22, 2014
Octocat-spinner-32 new_project Different CSS formatters support January 28, 2014
Octocat-spinner-32 src refactor(Gruntfile): refactor for `grunt before-test` task January 22, 2014
Octocat-spinner-32 test feat(lib): Users can now pass the NODE_ENV to set the environment February 16, 2014
Octocat-spinner-32 .gitignore 0.3alpha3 release February 09, 2012
Octocat-spinner-32 .jshintignore 1. Added manual for contributors 'CONTRIBUTING.md' August 20, 2013
Octocat-spinner-32 .jshintrc 1. Added manual for contributors 'CONTRIBUTING.md' August 20, 2013
Octocat-spinner-32 .npmignore chore(npmignore): Added `docs` dir to `.npmignore` February 03, 2014
Octocat-spinner-32 .travis.yml 1. Node.js required version bumbed to ">= 0.8.0" August 20, 2013
Octocat-spinner-32 CHANGELOG.md chore(CHANGELOG): Added empty CHANGELOG.md January 22, 2014
Octocat-spinner-32 CONTRIBUTING.md chore(CONTRIBUTING): Typo fix January 29, 2014
Octocat-spinner-32 Gruntfile.js chore(Gruntfile): fix description for `release:complete` task January 24, 2014
Octocat-spinner-32 HISTORY.md Updating for version 0.3.10 October 07, 2013
Octocat-spinner-32 LICENSE Version 0.3.5 August 12, 2013
Octocat-spinner-32 README.md Fix Gitter badge URL March 06, 2014
Octocat-spinner-32 TODO.md Doc update / Second attempt at Travis CI test for Node 0.8 July 16, 2012
Octocat-spinner-32 index.js Removed 'make build' task and SS_DEV option from the code August 18, 2013
Octocat-spinner-32 package.json chore(release): Starting v0.3.11-SNAPSHOT February 03, 2014
README.md

SocketStream!

SocketStream

Build Status Dependency Status devDependency Status Code Climate Gitter chat

Latest release: 0.3.10 (view changelog)

A fast, modular Node.js web framework dedicated to building single-page realtime apps

Live demo | Documentation

Introduction

SocketStream is a new breed of web framework that uses websockets to push data to the browser in 'realtime'. It makes it easy to create blazing-fast, rich interfaces which behave more like desktop apps than traditional web apps of the past.

By taking care of the basics, SocketStream frees you up to focus on building your social/chat app, multiplayer game, trading platform, sales dashboard, or any kind of web app that needs to display realtime streaming data. All personal tastes (e.g. Vanilla JS vs CoffeeScript, Stylus vs Less) are catered for with optional npm modules that integrate perfectly in seconds, without bloating the core.

Learn more by taking a tour of the features, or watching a recent talk (recorded September 2012).

Why SocketStream?

Building a simple chat app that uses websockets is easy. Building a rich, non-trivial, responsive realtime UI without ending up with a mess of code is hard.

SocketStream eases the pain by:

  • Integrating best-of-breed modules to increase productivity
  • Providing a sensible place to put everything
  • Accelerating development with Live Reload and (optional) support for Stylus, Jade, etc
  • Accelerating deployment with integrated asset packing and CDN support
  • Organizing spaghetti client-side code into modules you can require()
  • Working well with all major client-side frameworks (e.g. Backbone, Ember, Angular)
  • Making it easy to hookup Redis, MongoDB, CouchDB or other storage engines
  • Providing an active community to answer your question

No other realtime framework plays as well with the entire Node.js ecosystem, or gives you the flexibility to swap-out code pre-processors, template engines or even websocket transports until you have the very best custom stack for your app.

SocketStream is MIT licensed.

Status

SocketStream 0.3 is now stable enough for production use internally (behind a firewall). Several pioneering users are successfully hosting external apps in production, though we ask you to use caution and appreciate that SocketStream is new software which has yet to be battle hardened. SocketStream 0.3 will continue to be updated with bug fixes and minor feature enhancements.

All major development work is going on in SocketStream 0.4 which builds upon the features and ideas in 0.3. Thanks to a new modular approach, SocketStream 0.4 will provide the initial ease of an integrated web framework with the flexibility of small modules that do one thing well. Read more.

Contact

Twitter: @socketstream
Google Group: http://groups.google.com/group/socketstream
IRC channel: #socketstream on freenode

Features

Client Side

  • Use require() and exports in your client-side code as you would on the server
  • Define multiple single-page clients by choosing the CSS, JS and client-side templates you wish to serve
  • Integrated asset manager - packages and minifies all client-side assets. Includes CDN support
  • Live Reload - automatically reloads the browser when a HTML, CSS or JS client file changes
  • Comprehensive support for client-side templates - use Hogan/Mustache/CoffeeKup/jQuery or write your own wrapper
  • Use optional code formatters (e.g. CoffeeScript, Jade, Stylus, Less, etc) by easily installing wrapper modules
  • Multiple clients work seamlessly with HTML Push State 'mock routing' so you can use Backbone Router, Davis JS and more
  • Works great with Ember.js for 'reactive templates' which automatically update when data changes
  • Bundled with jQuery - though not dependent on it. Will work great with Zepto and other libraries
  • Easily use additional client libraries such as Underscore.js

Server Side

  • True bi-directional communication using websockets (or websocket fallbacks). No more slow, messy AJAX!
  • Modular Websocket Transports - switch between Socket.IO (bundled by default) or SockJS without changing your app code
  • Easily share code between the client and server. Ideal for business logic and model validation (see FAQs below)
  • Request Middleware - enabling session access, authentication, logging, distributed requests and more
  • Effortless, scalable, pub/sub baked right in - including Private Channels
  • Easy authentication - use a backend database or authenticate against Facebook Connect, Twitter, etc using Everyauth
  • Uses Connect 2.0 - Hook-in your own HTTP middleware, share sessions between HTTP/Connect/Express/SocketStream
  • Optionally use Redis for fast session retrieval, pub/sub, list of users online, and any other data your app needs instantly

Optional Modules (officially maintained and supported)


How does it work?

SocketStream sends all the static HTML, CSS and client-side code your app needs the first time a user visits your site (all automatically compressed in production mode).

From then on all application data is sent and received via the websocket (or websocket fallbacks), instantly established when the client connects and automatically re-established if broken. Normally this will be in JSON RPC format, but SocketStream 0.3 allows you to use different Request Responders (message handlers) depending upon the task at hand.

All this means no more connection latency, HTTP header overhead, polling, or clunky AJAX. Just true bi-directional, asynchronous, 'streaming' communication between client and server.

Getting Started

Ready to give it a whirl? Install Node 0.10.X then get SocketStream from npm:

[sudo] npm install -g socketstream

To generate a new empty SocketStream project type:

socketstream new <name_of_your_project>

Tip: Type socketstream -h to view all available options

Install the bundled (optional) dependencies:

cd <name_of_your_project>
[sudo] npm install

To start your app simply type:

node app.js

If all goes well you'll see the SocketStream banner coming up, then you're ready to visit your new app at:

http://localhost:3000

What can I create with it?

SocketStream is a perfect fit for all manner of modern applications which require realtime data (chat, stock trading, location monitoring, analytics, etc). It's also a great platform for building realtime HTML5 games.

However, it would make a poor choice for a blog or other content-rich site which requires unique URLs for search engine optimization.

Demo Apps

0.3 apps in production: Dashku.com

More code examples to follow.

Example 1: Basic RPC

SocketStream 0.3 supports multiple ways to send messages to and from the server. The most common of which, JSON-over-RPC, is included by default. An RPC call can be invoked on the server by calling ss.rpc() in the browser.

For example, let's write a simple server-side function which squares a number:

// in /server/rpc/app.js
exports.actions = function(req, res, ss){

  // return list of actions which can be called publicly
  return {

    square: function(number){
      res(number * number);
    }

  }
}

Restart the server and then invoke this function from the browser's command line:

ss.rpc('app.square', 25)

You'll see the answer 625 logged to the console by default. The eagle-eyed among you will notice ss.rpc('app.square', 25) actually returned undefined. That's fine. We're only interested in the asynchronous response sent from the server once it has processed your request.

You may be wondering why app.square? Because we're invoking the square action/function in the app.js file. If you had written a resize action in /server/rpc/image/processor.js you'd call it with ss.rpc('image.processor.resize'). This naming convention allows you to create as many sub-directories as you wish to organize your code.

Now let's write some code in the client to do more with this response:

// client/code/app/demo.js

// define the number to square (vars are local to this file by default)
var number = 25;

ss.rpc('app.square', number, function(response){
  alert(number + ' squared is ' + response);
});

Once you save the file, the browser will automatically reload and you'll see an alert box popup with the following:

25 squared is 625

More examples coming soon!

Documentation

Please start with http://www.socketstream.org/tour which walks you through the key features and shows you the code.

Documentation is constantly expanding and currently available in English and Korean.

Developing (Client-side)
Developing (Server-side)
Best Practices
Extending SocketStream
Other

FAQs?

What browsers will SocketStream work with?

SocketStream works best with Chrome, Safari, Firefox 6 (and above) which all support native websockets. It is also compatible with older versions of Firefox and IE thanks to Socket.IO fallback transports. In addition, iPads and iPhones using Mobile Safari (iOS 4.2 and above) are fully supported, even over 3G.

How can I make my app auto-restart when /server code changes?

Install the excellent 'nodemon' module with sudo npm install -g nodemon then start your app with nodemon app.js. A .nodemonignore file has already been created for you with the optimal settings. This feature is very useful when developing your app.

How can I configure Socket.IO?

You may fully configure the Socket.IO server and client libraries like so:

ss.ws.transport.use('socketio', {
  client: {
    transports: ['websocket', 'htmlfile', 'xhr-polling', 'jsonp-polling']
  },
  server: function(io){
    io.set('log level', 4)
  }
});
Where can I deploy my apps to?

SocketStream works great with Nodejitsu.com, as well as custom EC2 / cloud servers. Sadly Heroku.com does not currently support websockets.

Will it run on Windows?

Yes. We have many users running SocketStream on Windows without problems. Make sure that you have Make for Windows installed beforehand.

How can I share code between client and server?

Simply require() one of your client-side modules in your server-side code.

Does SocketStream support models?

No. Not in the core.

Instead we offer a powerful API to allow developers to experiment with opinionated approaches to model synching, client-side APIs (e.g. simulating MongoDB in the browser), serialization protocols, and much more.

Several third-party add-on modules (for Backbone, Angular and more) are now in active development by the community. Please search our Google Group for details.

Ideally we'd like to end up with one great, well-maintained module for each major client-side framework which allows for seamless high-speed model syncing to your choice of persistent store. The best modules will be featured on our website in the near future, giving you the ability to pick the best tools for your particular use-case.

Should I use Redis?

Yes. SocketStream installs the Redis driver by default but does not require Redis to be running when developing your app (for convenience sake). However, as soon as you want to host your app for real, you need to be using Redis.

Redis is used in two areas of SocketStream - session storage and internal pubsub (used by ss.publish commands). You can enable Redis in your app with the following commands in your app.js file:

ss.session.store.use('redis');
ss.publish.transport.use('redis');

Pass any config as the second argument to either of the above commands as so:

{host: 'localhost', port: 6379, pass: 'myOptionalPass', db: 3}
How about scaling?

SocketStream 0.3 makes a big assumption in order to maximize speed and reduce code complexity: All incoming connections with the same session should be routed to the same server (also known as Sticky Sessions). The session details are stored in memory and then optionally saved to Redis to preserve the session should the node fail.

Front end scaling can be achieved using a combination of different websocket transports (such as the forthcoming Pusher Pipe module) and optional features we intend to introduce in the future.

Back end scaling has yet to be properly documented, but we're keen to continue looking into ways to use ZeroMQ and also Hook IO. We will make sure back end scaling is as easy and flexible as possible, but it will no longer be a feature of the framework itself.

Videos

(most recent at end)

Developing on the SocketStream core

SocketStream (up to 0.3.5) was primarily written in CoffeeScript, and was 'pre-compiled' into JavaScript using make build. From 0.3.6, SocketStream is now written in Javascript.

We are moving towards linting all of the code in the lib directory with JSHint. There is a Grunt task to help with this process. First, install the grunt-cli module (based on instructions here: http://gruntjs.com/getting-started), and then you can run the following commands:

grunt jshint:server
grunt jshint:client

If you run these grunt tasks (at time of writing), you will encounter the following feedback:

Warning: Task "jshint:server" failed. Use --force to continue.

Aborted due to warnings.

When SocketStream was written the codebase was not linted. We've decided to use Linting from now in order to enhance the quality of the codebase, but this means that you will see this message shown above, until we've managed to lint the codebase. The warning indicates that there is a lot of work to do.

Recommended alternatives to SocketStream

We hope you'll find SocketStream is a great fit for your app, but if it's not exactly what you're looking for, consider these alternatives:

If SEO is important to you, take a look at Derby. If you're looking for an end-to-end commercial solution, Meteor is the best out there.

Testing

There are a number of Mocha tests starting to appear for parts of the API which are unlikely to change. To run them type:

$ grunt test

More tests coming soon. Contributions very much appreciated.

Contributors

Original Creator: Owen Barnes

Lead Developer: Paul Jensen

Big thanks to those who have contributed in the past: Addy Osmani for his help with everything JavaScript related, Alan Milford for providing initial demos, and Craig Jordan Muir for designing the SocketStream logo that has become synomymous with SocketStream's identity.

Thanks to those who have recently been helping to improve SocketStream in recent months: Robert Hall for his work on the new documentation for SocketStream, Roman Minkin for his bug fixes, feature contributions and improvements to the framework, and others who are passionate about SocketStream and wish to see it grow.

Thanks also to the many who have contributed code and ideas. We plan to properly feature contributors on our website in the near future, as derived from analysing SocketStream's git commit history, as well as honoouring plugin authors.

Credits

Thanks to Guillermo Rauch (Socket.IO), TJ Holowaychuk (Stylus, Jade), Substack (Browserify), Jeremy Ashkenas (CoffeeScript), Mihai Bazon (UglifyJS), Isaac Schlueter (NPM), Salvatore Sanfilippo (Redis) and the many others who's amazing work has made SocketStream possible. Special thanks to Ryan Dahl (creator of node.js) for the inspiration to do things differently.

License

SocketStream is released under the MIT license.

Something went wrong with that request. Please try again.