![\"JavaScript](\"./docs/public/logo.svg\"){kind=logo}
\n \n\n \n \n \n
\n ![\"Current](\"https://img.shields.io/github/v/release/maxnowack/signaldb?include_prereleases&label=version&sort=semver\")
![\"Status](\"https://img.shields.io/github/checks-status/maxnowack/signaldb/main\")
![\"TypeScript\"](\"https://img.shields.io/npm/types/signaldb\")
![\"Coverage\"](\"https://img.shields.io/codecov/c/github/maxnowack/signaldb\")
![\"License\"](\"https://img.shields.io/github/license/maxnowack/signaldb\")
![](\"https://img.shields.io/discord/1277179248725200937\"){kind=small}
![\"Stargazers\"](\"https://img.shields.io/github/stars/maxnowack/signaldb\")
\n Get Started |\n Guide for React |\n Core Concepts |\n Reactivity Adapters |\n Discord\n
\n\n# SignalDB: Real-Time Client-Side Database with Optimistic UI\n\nSignalDB is a client-side database optimized for modern web applications, offering a MongoDB-like interface with robust TypeScript support to improve development speed and ensure type safety. SignalDB supports creating an optimistic UI for responsive, dynamic interfaces and offers versatile local data persistence with various storage providers. SignalDB is also able to gather data from multiple sources, enabling real-time updates and synchronization (see examples for [AppWrite](https://github.com/maxnowack/signaldb/tree/main/examples/appwrite), [Firebase](https://github.com/maxnowack/signaldb/tree/main/examples/firebase), [Supabase](https://github.com/maxnowack/signaldb/tree/main/examples/supabase), [RxDB](https://github.com/maxnowack/signaldb/tree/main/examples/rxdb) and [HTTP](https://github.com/maxnowack/signaldb/tree/main/examples/replication-http)).\nDesigned for efficiency in applications requiring quick data handling and real-time interactions, SignalDB provides instant data access, minimizing latency typical of server-side databases. Its lightweight architecture is framework-agnostic, making it suitable for both small and large-scale projects that require flexible, intuitive data management solutions. SignalDB provides adapters for popular reactive libraries including [Angular](https://signaldb.js.org/reactivity/angular/), [React](https://signaldb.js.org/guides/react/) (through 3rd party signal libraries), [Solid.js](https://signaldb.js.org/reactivity/solidjs/), [Vue.js](https://signaldb.js.org/reactivity/vue/) and many more.\n\n## Installation\n\n````\n $ npm install signaldb\n````\n\n## Usage\n\n```js\nimport { Collection } from 'signaldb'\n\nconst posts = new Collection()\nconst postId = posts.insert({ title: 'Foo', text: 'Lorem ipsum …' })\nconst cursor = collection.find({})\nconsole.log(cursor.fetch()) // returns an array with all documents in the collection\n```\n\n### Reactivity\nIn theory, every signal library is supported. SignalDB currently have pre-build reactivity adapters for these libraries:\n* [**@preact/signals-core**](https://signaldb.js.org/reactivity/preact-signals/)\n* [**@reactively/core**](https://signaldb.js.org/reactivity/reactively/)\n* [**Angular**](https://signaldb.js.org/reactivity/angular/)\n* [**Maverick-js Signals**](https://signaldb.js.org/reactivity/maverickjs/) (current favorite for usage with React)\n* [**Meteor Tracker**](https://signaldb.js.org/reactivity/meteor-tracker/)\n* [**MobX**](https://signaldb.js.org/reactivity/mobx/)\n* [**oby**](https://signaldb.js.org/reactivity/oby/)\n* [**S.js**](https://signaldb.js.org/reactivity/s-js/)\n* [**sinuous**](https://signaldb.js.org/reactivity/sinuous/)\n* [**Solid.js**](https://signaldb.js.org/reactivity/solidjs/)\n* [**usignal**](https://signaldb.js.org/reactivity/usignal/)\n* [**Vue.js**](https://signaldb.js.org/reactivity/vue/)\n* *and more to come!*\n\nMore information in the [reactivity section](https://signaldb.js.org/reactivity/) of the documentation.\n\n```js\nimport { effect } from '@preact/signals-core'\n// OR\nimport { effect } from '@angular/core'\n// OR\nimport { autorun as effect } from 'mobx'\n// OR\nimport { createEffect as effect } from 'solid-js'\n// OR\nimport { watchEffect as effect } from 'vue'\n// ...\n\nconst posts = new Collection({\n reactivity: /* ... */ // see https://signaldb.js.org/reactivity/ for reactivity adapters for your favorite library,\n})\n\neffect(() => { // will be executed everytime the query result changes\n const cursor = posts.find({ author: 'John' })\n console.log(cursor.count())\n})\n\n```\n\n## Architecture\n\n### Reactivity\n\nSignalDB harnesses the power of signal-based reactivity to offer a dynamic and responsive user experience. Our architecture integrates seamlessly with various signal libraries, ensuring compatibility and flexibility across different JavaScript frameworks. Whether you're using Angular, React, Vue.js, or others, SignalDB adapts to your preferred environment, enhancing the reactivity of your web applications. Also see the [Core Concepts](https://signaldb.js.org/core-concepts/) to leaarn more about the reactivity in SignalDB.\n\n### Collections & Queries\n\nAt the heart of SignalDB lies its advanced handling of collections and queries. Our in-memory data storage approach ensures blazing-fast query performance, perfect for applications requiring real-time data manipulation and retrieval. This setup allows for a synchronous API, eliminating the complexity of asynchronous operations and making data handling straightforward and efficient. SignalDB's query system is based on [MongoDB's query syntax](https://www.mongodb.com/docs/manual/reference/operator/query/) using [mingo](https://github.com/kofrasa/mingo) under the hood, providing a familiar and powerful querying experience. Learn more about [Collections](https://signaldb.js.org/collections/) and [Queries](https://signaldb.js.org/queries/) in the documentation.\n\n### Synchronization with external systems\n\nSignalDB also implements a state-of-the-art data sync engine, drawing inspiration from established replication protocols like [RxDB replication](https://rxdb.info/replication.html), [WatermelonDB sync](https://watermelondb.dev/docs/Sync/Frontend) and [replicache](https://replicache.dev). It supports any backend and makes it easy to integrate even RESTful APIs as well, without the need for websockets. This feature is particularly useful for offline-first applications, ensuring data consistency and availability even when the network connection is intermittent or unavailable. Take a look at the documentation page for [Synchronization](https://signaldb.js.org/sync/) for more information.\n\n### Data Persistence\n\nSignalDB's data persistence layer is designed for scalability and flexibility. It offers various strategies for persisting data, from simple `localStorage` implementations to more complex external systems. This versatility allows for customization based on your application's needs, ensuring data is stored efficiently and securely. Our architecture supports the evolution of your application, providing a solid foundation for growth and expansion.\nSee the [Persistence Adapters](https://signaldb.js.org/persistence/) page in the documentation to learn more.\n\n## License\nLicensed under MIT license. Copyright (c) 2024 Max Nowack\n\n## Contributions\nContributions are welcome. Please open issues and/or file Pull Requests.\n\n## Maintainers\n- Max Nowack ([maxnowack](https://github.com/maxnowack))\n","readmeFilename":"README.md"}