index

A standalone, client-side datastore for web applications. This module provides a local, in-browser database built on PouchDB, leveraging the same data model and API structure as its docstack server counterpart. It is designed for offline-first applications and direct data management without requiring an active server connection.

✨ Features

Local Data Persistence: Utilizes PouchDB to store your structured data directly in the browser's storage.

Offline-First: Provides full read/write access to your data even without an internet connection.

Shared Data Models: Implements the same data model principles as the docstack server, ensuring consistency across your application stack.

Seamless Replication: Designed to be easily replicated with a CouchDB or docstack server instance when a connection is available.

📦 Installation

To add the client to your project, use your preferred package manager.

npm install @docstack/client

🚀 Usage

First, import and instantiate the DocstackClient with the desired database name. This will create or open a PouchDB database in the browser.

import {DocStack} from '@docstack/client';

const client = new DocStack('local-ds');

Then, use the provided methods to interact with your local data. Most methods are asynchronous and return a Promise.