/mongodb-realtime

Primary LanguageTypeScriptMIT LicenseMIT


MongoDB Realtime

GitHub License npm Version

MongoDB Realtime is an experimental library that aims to provide real-time capabilities for MongoDB, inspired by the functionalities of Firebase and react-firebase-hooks. The end goal is to enable real-time updates from your MongoDB instance to the client through your NodeJS server.

This is implemented by using MongoDB's Change Streams and Change Events on the db-->server and websockets from the server<-->client. This library consists of 3 packages:

Please Note: This project is currently in active development and is considered experimental. It may not be production-ready.

Features

  • Real-time Updates: Instantly receive updates when documents in your MongoDB collection change.

Getting Started

Server

Installation

Install the package via npm:

npm install @mongodb-realtime/server

Usage

TODO

Client

Installation

Install the package via npm:

npm install @mongodb-realtime/client

Usage

TODO

For more detailed usage instructions and options, refer to the Documentation.

Contributing

As this project is experimental, you would probably encounter bugs and issues. If you do, please report them in the [Issues]( PRs are welcome!

License

This project is licensed under the MIT License.

Acknowledgements

  • This project trys to mimic how Firebase and react-firebase-hooks work.