Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/maxnowack/signaldb

SignalDB is a local JavaScript database with a MongoDB-like interface and TypeScript support, enabling optimistic UI with signal-based reactivity across multiple frameworks. It integrates easily with libraries like Angular, Solid.js, Preact, and Vue, simplifying data management with schema-less design, in-memory storage, and fast queries.
https://github.com/maxnowack/signaldb

client client-database database hacktoberfest live-updates local-database meteor mongodb offline-first optimistic-ui reactive reactive-programming reactivity real-time replication signals synchronization tracker typescript

Last synced: 6 days ago
JSON representation

SignalDB is a local JavaScript database with a MongoDB-like interface and TypeScript support, enabling optimistic UI with signal-based reactivity across multiple frameworks. It integrates easily with libraries like Angular, Solid.js, Preact, and Vue, simplifying data management with schema-less design, in-memory storage, and fast queries.

Awesome Lists containing this project

README 

        


  

    JavaScript Database

  






  Current Version

  Status Checks

  TypeScript

  Coverage

  License

  

  Stargazers






   Get Started |

   Guide for React |

   Core Concepts |

   Reactivity Adapters |

   Discord




# SignalDB: Real-Time Client-Side Database with Optimistic UI



SignalDB 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)).

Designed 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.



## Installation



````

  $ npm install signaldb

````



## Usage



```js

import { Collection } from 'signaldb'



const posts = new Collection()

const postId = posts.insert({ title: 'Foo', text: 'Lorem ipsum …' })

const cursor = collection.find({})

console.log(cursor.fetch()) // returns an array with all documents in the collection

```



### Reactivity

In theory, every signal library is supported. SignalDB currently have pre-build reactivity adapters for these libraries:

* [**@preact/signals-core**](https://signaldb.js.org/reactivity/preact-signals/)

* [**@reactively/core**](https://signaldb.js.org/reactivity/reactively/)

* [**Angular**](https://signaldb.js.org/reactivity/angular/)

* [**Maverick-js Signals**](https://signaldb.js.org/reactivity/maverickjs/) (current favorite for usage with React)

* [**Meteor Tracker**](https://signaldb.js.org/reactivity/meteor-tracker/)

* [**MobX**](https://signaldb.js.org/reactivity/mobx/)

* [**oby**](https://signaldb.js.org/reactivity/oby/)

* [**S.js**](https://signaldb.js.org/reactivity/s-js/)

* [**sinuous**](https://signaldb.js.org/reactivity/sinuous/)

* [**Solid.js**](https://signaldb.js.org/reactivity/solidjs/)

* [**usignal**](https://signaldb.js.org/reactivity/usignal/)

* [**Vue.js**](https://signaldb.js.org/reactivity/vue/)

* *and more to come!*



More information in the [reactivity section](https://signaldb.js.org/reactivity/) of the documentation.



```js

import { effect } from '@preact/signals-core'

// OR

import { effect } from '@angular/core'

// OR

import { autorun as effect } from 'mobx'

// OR

import { createEffect as effect } from 'solid-js'

// OR

import { watchEffect as effect } from 'vue'

// ...



const posts = new Collection({

  reactivity: /* ... */ // see https://signaldb.js.org/reactivity/ for reactivity adapters for your favorite library,

})



effect(() => { // will be executed everytime the query result changes

  const cursor = posts.find({ author: 'John' })

  console.log(cursor.count())

})



```



## Architecture



### Reactivity



SignalDB 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.



### Collections & Queries



At 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.



### Synchronization with external systems



SignalDB 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.



### Data Persistence



SignalDB'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.

See the [Persistence Adapters](https://signaldb.js.org/persistence/) page in the documentation to learn more.



## License

Licensed under MIT license. Copyright (c) 2024 Max Nowack



## Contributions

Contributions are welcome. Please open issues and/or file Pull Requests.



## Maintainers

- Max Nowack ([maxnowack](https://github.com/maxnowack))