Skip to content
Open Source API for Realtime Web Apps
TypeScript HTML JavaScript Shell
Branch: master
Clone or download

README.md

HiDB

Build Status Coverage Status Greenkeeper badge

HiDB is an open source API for realtime web apps. It sets up peer-to-peer connections via webRTC, and backs that up with a more reliable client/server WebSocket connection.

  • Fast: Updates are sent peer to peer to minimize latency.
  • Light: hidb-client is 3kb, and has no dependencies.
  • Offline-First: User actions are applied optimistically until a connection becomes available.

Live Demos

Server Installation

npm i hidb-server

Client Installation

npm i hidb-client

Documentation

Examples

Examples can be found in /examples.

Contributing

See CONTRIBUTING.md

License

MIT

You can’t perform that action at this time.