node package manager
Stop wasting time. Easily manage code sharing in your team. Create a free org »

deepstream.io

deepstream.io: The Open Realtime Server


deepstream is a new type of server that syncs data and sends events across millions of clients

Build Status npm version Coverage Status dependencies Status devDependencies Status

Quick links to useful resources on getting started:

  1. Installing deepstream
  2. Getting started
  3. Tutorials
  4. Documentation
  5. Deploying on AWS

Community Links

  1. Slack
  2. Twitter
  3. Stack Overflow

Development Guide

Deepstream development is a great way for you to go into depth about building performant nodeJS applications, and contributions are always welcome with lots of ❤

Contributing to deepstream.io is as simple as:

  1. Downloading nodeJS (4+)
  2. Cloning the repo
  3. Run npm i / yarn install to install dependencies
  4. Make your changes / Add a test
  5. Run npm t to see if the unit tests all pass
  6. Run sh ./scripts/run-e2e.sh if your changes are quite big. But otherwise CI can take care of that for you ;)

For power users who want to make sure the binary works, you can run sh scripts/package.sh true. You'll need to download the usual node-gyp build environment for this to work and we only support the latest LTS version to compile. This step is usually not needed though unless your modifying resource files or changing dependencies.

Post release sanity test for linux distributions:

  1. access a linux machine

  2. copy over the sanity test using:

curl -O https://raw.githubusercontent.com/deepstreamIO/deepstream.io/master/scripts/sanity-test.sh

  1. depending on your distribution, run
  • debian/ubuntu: bash sanity-test.sh deb
  • centos/aws: bash sanity-test.sh rpm
  • any linux distro: bash sanity-test.sh tar