/socketstream

A framework for Realtime Web Apps

Primary LanguageJavaScriptMIT LicenseMIT

SocketStream!

SocketStream

Build Status Dependency Status devDependency Status Code Climate Codacy Badge NPM version Gitter chat Issue Stats Issue Stats Coverage Status Stories in Ready

Introduction

SocketStream is a framework for Realtime Web Apps

Latest release: 0.4.2 (view changelog)

Live demo | Documentation

Installation

Please note that this is release with many modifications. It is expected to be robust and changes are well covered by tests. If you are already in production use 0.3.12, or even better test this in a staging environment.

npm install -g socketstream

Usage

socketstream new <your_app_name>
cd <your_app_name>
npm install
npm start

Then open a web browser at localhost:3000:

open http://localhost:3000

Why SocketStream?

Building a simple chat app that uses websockets is easy, but 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, and other transpilers.
  • Accelerating deployment with integrated asset packing and CDN support
  • Organizing spaghetti client-side code into modules you can require() with Browserify
  • Working well with all major client-side frameworks (e.g. Backbone, Ember, Angular)

Applications using SocketStream

  • Dashku: Realtime dashboards and widgets using HTML, CSS and JavaScript. Also hosted at dashku.com.
  • SketchDeck: An app for designing great slide decks from sketches, also a Y Combinator tech startup.
  • Hollow: An interactive, emmy-nominated documentary.
  • Bitjoy: Realtime Bitcoin prices and news.
  • Teeleader: A booking engine for Golf courses.

Presentations

Videos

(most recent at end)

Documentation

Checkout the documentation here.

Next Major Release 0.5

Build Status Coverage Status

Notes

This upcoming is expected in July. The current state can be found on the next branch.

Team

Creator: Owen Barnes

Core Contributors:

  • Paul Jensen
  • Roman Minkin
  • Robert Hall
  • Joshua Cullick
  • Henrik Vendelbo

Contact

License

SocketStream is released under the MIT license.