Have ideas to improve npm?Join in the discussion! »

    sharedb
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/sharedb package

    1.8.1 • Public • Published

    This README is for sharedb@1.x. For sharedb@1.x-beta, see the 1.x-beta branch. To upgrade, see the upgrade guide.

    ShareDB

    NPM Version Test Coverage Status

    ShareDB is a realtime database backend based on Operational Transformation (OT) of JSON documents. It is the realtime backend for the DerbyJS web application framework.

    For questions, discussion and announcements, join the ShareJS mailing list or check the FAQ.

    Please report any bugs you find to the issue tracker.

    Features

    • Realtime synchronization of any JSON document
    • Concurrent multi-user collaboration
    • Synchronous editing API with asynchronous eventual consistency
    • Realtime query subscriptions
    • Simple integration with any database
    • Horizontally scalable with pub/sub integration
    • Projections to select desired fields from documents and operations
    • Middleware for implementing access control and custom extensions
    • Ideal for use in browsers or on the server
    • Offline change syncing upon reconnection
    • In-memory implementations of database and pub/sub for unit testing
    • Access to historic document versions
    • Realtime user presence syncing

    Documentation

    https://share.github.io/sharedb/

    Examples

    Counter

    Leaderboard

    Development

    Documentation

    The documentation is stored as Markdown files, but sometimes it can be useful to run these locally. The docs are served using Jekyll, and require Ruby >2.4.0 and Bundler:

    gem install jekyll bundler

    The docs can be built locally and served with live reload:

    npm run docs:install
    npm run docs:start

    Keywords

    none

    Install

    npm i sharedb

    DownloadsWeekly Downloads

    8,403

    Version

    1.8.1

    License

    MIT

    Unpacked Size

    2.64 MB

    Total Files

    149

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar