Narnia's Poofy Meatcleaver

    @deepstream/server

    6.2.1 • Public • Published

    deepstream - the open realtime server deepstream

    deepstream is an open source server inspired by concepts behind financial trading technology. It allows clients and backend services to sync data, send messages and make rpcs at very high speed and scale.

    npm versionDocker Stars

    deepstream has three core concepts for enabling realtime application development

    records are schema-less, persistent documents that can be manipulated and observed. Any change is synchronized with all connected clients and backend processes in milliseconds. Records can reference each other and be arranged in lists to allow modelling of relational data

    events allow for high performance, many-to-many messaging. deepstream provides topic based routing from sender to subscriber, data serialisation and subscription listening.

    remote procedure calls allow for secure and highly available request response communication. deepstream handles load-balancing, failover, data-transport and message routing.

    deepstream offers a combination of different authentication mechanisms with a powerful permission-language called Valve that allows you to specify which user can perform which action with which data.

    Getting Started:

    1. Tutorials - What is deepstream
    2. Installing deepstream
    3. Quickstart
    4. Documentation

    Community Links

    1. Stack Overflow
    2. Github Discussions

    Contributing

    deepstream development is a great way to get into building performant Node.js applications, and contributions are always welcome with lots of . Contributing to deepstream is as simple as having Node.js (10+) and TypeScript (3+) installed, cloning the repo and making some changes.

    ~ » git clone git@github.com:deepstreamIO/deepstream.io.git
    ~ » cd deepstream.io
    ~/deepstream.io » git submodule update --init
    ~/deepstream.io » npm i
    ~/deepstream.io » npm start
          _                     _
       __| | ___  ___ _ __  ___| |_ _ __ ___  __ _ _ __ ____
      / _` |/ _ \/ _ \ '_ \/ __| __| '__/ _ \/ _` | '_ ` _  \
     | (_| |  __/  __/ |_) \__ \ |_| | |  __/ (_| | | | | | |
      \__,_|\___|\___| .__/|___/\__|_|  \___|\__,_|_| |_| |_|
                     |_|
     =====================   starting   =====================
    

    From here you can make your changes, and check the unit tests pass:

    ~/deepstream.io » npm t
    

    If your changes are substantial you can also run our extensive end-to-end testing framework:

    ~/deepstream.io » npm run e2e
    

    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.

    Keywords

    none

    Install

    npm i @deepstream/server

    DownloadsWeekly Downloads

    104

    Version

    6.2.1

    License

    MIT

    Unpacked Size

    2.29 MB

    Total Files

    444

    Last publish

    Collaborators

    • yasserf
    • valentinvichnal
    • jaime-ez