# SignalDB

> Reactive Local-First JavaScript Database

Signals for instant UI updates, plus real-time sync when you need it.

## Table of Contents

### Documentation

- [Getting Started](/getting-started.md)
- [Core Concepts](/core-concepts.md)
- [Querying Data](/queries.md)
- [Data manipulation](/data-manipulation.md)
- [Data Persistence Adapters](/data-persistence.md)
- [Reactivity & Optimistic UI](/reactivity.md)
- [Overview of Synchronization in SignalDB](/sync.md)
- [Object-Relational Mapping (ORM) with SignalDB](/orm.md)
- [Developer Tools](/devtools.md)
- [Schema Validation in SignalDB](/schema-validation.md)
- [Upgrade to v1](/upgrade/v1.md)

### Changelog

- [Changelog for [`@signaldb/core`](https://www.npmjs.com/package/@signaldb/core)](/changelog/core.md)
- [Changelog for [`@signaldb/sync`](https://www.npmjs.com/package/@signaldb/sync)](/changelog/sync.md)
- [Changelog for [`@signaldb/devtools`](https://www.npmjs.com/package/@signaldb/devtools)](/changelog/devtools.md)
- [Changelog for [`@signaldb/react`](https://www.npmjs.com/package/@signaldb/react)](/changelog/react.md)
- [Changelog for [`@signaldb/fs`](https://www.npmjs.com/package/@signaldb/fs)](/changelog/fs.md)
- [Changelog for [`@signaldb/indexeddb`](https://www.npmjs.com/package/@signaldb/indexeddb)](/changelog/indexeddb.md)
- [Changelog for [`@signaldb/localstorage`](https://www.npmjs.com/package/@signaldb/localstorage)](/changelog/localstorage.md)
- [Changelog for [`@signaldb/opfs`](https://www.npmjs.com/package/@signaldb/opfs)](/changelog/opfs.md)
- [Changelog for [`@signaldb/angular`](https://www.npmjs.com/package/@signaldb/angular)](/changelog/angular.md)
- [Changelog for [`@signaldb/maverickjs`](https://www.npmjs.com/package/@signaldb/maverickjs)](/changelog/maverickjs.md)
- [Changelog for [`@signaldb/meteor`](https://www.npmjs.com/package/@signaldb/meteor)](/changelog/meteor.md)
- [Changelog for [`@signaldb/mobx`](https://www.npmjs.com/package/@signaldb/mobx)](/changelog/mobx.md)
- [Changelog for [`@signaldb/oby`](https://www.npmjs.com/package/@signaldb/oby)](/changelog/oby.md)
- [Changelog for [`@signaldb/preact`](https://www.npmjs.com/package/@signaldb/preact)](/changelog/preact.md)
- [Changelog for [`@signaldb/reactively`](https://www.npmjs.com/package/@signaldb/reactively)](/changelog/reactively.md)
- [Changelog for [`@signaldb/sinuous`](https://www.npmjs.com/package/@signaldb/sinuous)](/changelog/sinuous.md)
- [Changelog for [`@signaldb/sjs`](https://www.npmjs.com/package/@signaldb/sjs)](/changelog/sjs.md)
- [Changelog for [`@signaldb/solid`](https://www.npmjs.com/package/@signaldb/solid)](/changelog/solid.md)
- [Changelog for [`@signaldb/svelte`](https://www.npmjs.com/package/@signaldb/svelte)](/changelog/svelte.md)
- [Changelog for [`@signaldb/usignal`](https://www.npmjs.com/package/@signaldb/usignal)](/changelog/usignal.md)
- [Changelog for [`@signaldb/vue`](https://www.npmjs.com/package/@signaldb/vue)](/changelog/vue.md)

### Guides

- [Use SignalDB in Angular](/guides/angular.md)
- [Use SignalDB with React](/guides/react.md)
- [Integrating SignalDB with Solid.js](/guides/solid-js.md)
- [Using SignalDB with Svelte 5](/guides/svelte.md)
- [Using SignalDB with Vue](/guides/vue.md)


### Help

- [Troubleshooting](/troubleshooting.md)

### Articles

- [JavaScript Signals](/signals.md)
- [Live Updates in Modern Apps](/live-updates.md)
- [Optimistic UI: How Local Databases Transform User Experience](/optimistic-ui.md)
- [Real-Time Web Apps](/real-time.md)
- [Offline-First Approach with Reactive JavaScript Databases](/offline-first.md)
- [Reactive JavaScript Databases and Popular JS Frameworks](/reactive-databases.md)
- [Leveraging AWS Amplify with Reactive Databases](/aws-amplify.md)
- [Combining Firebase with Reactive Local Databases](/firebase.md)
- [Optimistic UI with Client-side Databases and Supabase](/supabase.md)

### Base

- [SyncManager](/reference/sync.md)

#### @signaldb/core

- [Collection](/reference/core/collection.md)
- [Cursor](/reference/core/cursor.md)
- [AutoFetchCollection](/reference/core/autofetchcollection.md)
- [createIndex](/reference/core/createindex.md)
- [createIndexProvider](/reference/core/createindexprovider.md)
- [createMemoryAdapter](/reference/core/creatememoryadapter.md)
- [createPersistenceAdapter](/reference/core/createpersistenceadapter.md)
- [createReactivityAdapter](/reference/core/createreactivityadapter.md)
- [combinePersistenceAdapters](/reference/core/combinepersistenceadapters.md)

### Integrations

- [@signaldb/react](/reference/react.md)

### Persistence Adapters

- [@signaldb/fs](/reference/fs.md)
- [@signaldb/indexeddb](/reference/indexeddb.md)
- [@signaldb/localstorage](/reference/localstorage.md)
- [@signaldb/opfs](/reference/opfs.md)

### Reactivity Adapters

- [@signaldb/angular](/reference/angular.md)
- [@signaldb/maverickjs](/reference/maverickjs.md)
- [@signaldb/meteor](/reference/meteor.md)
- [@signaldb/mobx](/reference/mobx.md)
- [@signaldb/oby](/reference/oby.md)
- [@signaldb/preact](/reference/preact.md)
- [@signaldb/reactively](/reference/reactively.md)
- [@signaldb/sinuous](/reference/sinuous.md)
- [@signaldb/sjs](/reference/sjs.md)
- [@signaldb/solid](/reference/solid.md)
- [@signaldb/svelte](/reference/svelte.md)
- [@signaldb/usignal](/reference/usignal.md)
- [@signaldb/vue](/reference/vue.md)

### Other

- [Guides](/guides.md)
- [Reference](/reference.md)