Skip to content
A framework for Realtime Web Apps
JavaScript CSS Other
Branch: develop
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin Different CSS formatters support Jan 28, 2014
docs chore(release): v0.5.3 Dec 26, 2015
lib fix(cli): Fixes #602 Dec 26, 2015
misc chore(fixes): Updated dependencies and fixed linting Jan 2, 2015
new_project fix(styling): the default app would have background cropped with smal… Oct 24, 2015
src/docs doc update Nov 19, 2015
test common ss.sendAuth Nov 1, 2015
.editorconfig chore(lint): fixed some linting Mar 31, 2015
.gitconfig jade formatter default Oct 18, 2015
.gitignore ss.require.resolve Oct 3, 2015
.hound.yml test(hound): houndci config Mar 24, 2015
.javascript.json improved tests Jun 5, 2015
.jshintignore ss.require.resolve Oct 3, 2015
.jshintrc chore(linting): fixed linting issues Sep 29, 2015
.npmignore pre-commit correction Apr 22, 2015
.travis.yml Fix (support) Expand coverage to Node versions 4, and remove iojs Dec 12, 2016
CHANGELOG.md chore(release): v0.5.3 Dec 26, 2015
CONTRIBUTING.md
Gruntfile.js chore(release): v0.5.3 Dec 26, 2015
HISTORY.md changelog -> history Sep 27, 2015
LICENSE Version 0.3.5 Aug 12, 2013
README.md Update README.md May 15, 2019
express.js chore(doc): comments Nov 4, 2015
gulp.js feature(gulp): shortcut for importing SocketStream in a gulpfile.js Oct 30, 2015
index.js Removed 'make build' task and SS_DEV option from the code Aug 18, 2013
package.json Move commander to dependencies Dec 29, 2015

README.md

NOTICE - NO LONGER WORKED ON

Hi, SocketStream isn't maintained anymore, but the code is here for anyone who wants to take a look.

There are lots of other Node.js web application frameworks out there, please consider those instead for building your applications.

Paul Jensen, Wednesday 15th May, 2019.

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.5.3 unstable (view changelog)

Live demo | Documentation

For existing SocketStream installations you may want to remain on 0.4.5 for a while. It is the most backwards compatible and robust and well covered by tests. It should be ready for production.

The coming releases will see a lot of changes to accommodate new transport options modern browsers and mobile apps. The API will remain largely the same, but there are bound to be some changes.

Installation

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

Upgrade from 0.3 or 0.4 to 0.5

To make SocketStream more stable some major dependencies have been moved out. Please add these modules to package.json.

  • socketstream-cookie-session: 0.5.x
  • engine.io: 1.5.2
  • engine.io-client: 1.5.2
  • redis: 0.12.1
  • connect: 3.4.0

Why SocketStream?

The Real-Time web has been touted for years, and it is very much in use. However there remains a number of challenges that have not been solved. Web Sockets will remain an important technology for delivering a live experience on your website or mobile app. However with HTTP/2 and WebRTC other options come into play. SocketStream will help you to mix and match depending on what you aim to build.

It gives you tools to manage your project:

  • Providing a sensible place to put everything
  • Accelerating deployment with integrated asset packing and CDN support
  • Production Deployment skeleton
  • Good debugging output

Integration points:

  • Accelerating development with Live Reload and (optional) support for Stylus, Jade, and other transpilers.
  • Add-ons can be dropped in without configuration needed picking between Cookie and Token based auth.

Easy progression from REST

A good REST API will remain the right solution for many scenarios. Web pages will remain based on HTTP. Streaming is pixie dust sprinkled on top. SocketStream will be refactored to support a gradual addition on pixie dust keeping the REST structure as the central point.

Batteries included:

  • Dependencies are peer, so you pick the versions you want to use.
  • Built-in CommonJS bundler (ES6 on-the-way)
  • Built in formatter integration for: Sass, LESS, Stylus, Jade, Hogan
  • Built in template engine integration for: HTML5, React, Angular, jQuery
  • Built in transport integration for: Socket.io and SockJS
  • Examples

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:

How to

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.

Team

Owner: Henrik Vendelbo

Original Creator: Owen Barnes

Core Contributors:

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

Contact

License

SocketStream is released under the MIT license.

You can’t perform that action at this time.