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:
- @mongodb-realtime/server: A NodeJS server that listens to MongoDB's change streams and emits events to the client.
- @mongodb-realtime/client-react: A React integration for the client.
Please Note: This project is currently in active development and is considered experimental. It may not be production-ready.
- Real-time Updates: Instantly receive updates when documents in your MongoDB collection change.
Install the package via npm:
npm install @mongodb-realtime/server
TODO
Install the package via npm:
npm install @mongodb-realtime/client
TODO
For more detailed usage instructions and options, refer to the Documentation.
As this project is experimental, you would probably encounter bugs and issues. If you do, please report them in the [Issues]( PRs are welcome!
This project is licensed under the MIT License.
- This project trys to mimic how Firebase and react-firebase-hooks work.