Docs

Getting started Learn how to get started with LiveStore

Introduction Introduction to LiveStore

Evaluation Evaluate LiveStore for your use case

Patterns A collection of patterns for using LiveStore in different scenarios

Community Community resources for LiveStore

Contributing Contributing to LiveStore

State of the documentation

Please note that the documentation is still work in progress. Please leave feedback if you didn’t find the information you were looking for and consider contributing yourself.

Docs for LLMs

We support the llms.txt convention for making documentation available to large language models and the applications that make use of them.

Currently, we have the following root-level files:

Notes

• Most LiveStore APIs are synchronous and don't need await

• Docs

Getting started

• Getting started with LiveStore + React : How to use LiveStore with React on the web.
• Expo : Learn how to use LiveStore with Expo.
• Node : Learn how to use LiveStore with Node.
• Solid : Learn how to use LiveStore with Solid.
• Getting started with LiveStore + Vue : How to use LiveStore with Vue.

Tutorial

• Overview and prerequisites
• 1. Set up starter project with React, Vite & Tailwind
• 2. Deploy to Cloudflare Workers
• 3. Read and write todos via LiveStore
• 4. Sync data to Cloudflare
• 5. Expand business logic with more events
• 6. Persist UI state
• Next steps

Overview

• Introduction
• Why LiveStore?
• How LiveStore works
• Concepts : Concepts in LiveStore
• When to use LiveStore (and when not) : Considerations when deciding to use LiveStore.
• Technology comparison : How LiveStore compares to other related technologies

Building with LiveStore

• Rules for AI agents
• Events
• Data modeling
• CRUD : CRUD
• Store
• Complex UI state : How to model complex UI state in LiveStore.
• Reactivity system
• Syncing : Syncing
• Debugging a LiveStore app
• Devtools
• OpenTelemetry
• Production checklist : Checklist for productionizing a LiveStore app

State

• SQLite state schema
• SQLite state schema (Effect schema)
• SQL queries
• Materializers
• SQLite in LiveStore : Notes on how to use SQLite in LiveStore

Tools

• LiveStore CLI : Command-line interface for LiveStore project scaffolding and development tools.
• MCP integration : Model Context Protocol integration for AI assistants like Claude.

Examples

• Turn-based game : How to model a turn-based game in LiveStore.
• Todo app with shared workspaces : How to model a todo workspace app with shared workspaces in LiveStore.
• AI agent : How to model an AI agent in LiveStore.

Framework integrations

• Custom elements : How to integrate LiveStore with Custom Elements aka Web Components.
• React integration for LiveStore : How to integrate LiveStore with React.
• Solid integration : How to integrate LiveStore with Solid.
• Svelte integration : How to integrate LiveStore with Svelte.
• Vue integration for LiveStore : How to integrate LiveStore with Vue.

Platform adapters

• Web adapter : Information about LiveStore's web adapter
• Expo Adapter : LiveStore adapter for React Native apps built with Expo
• Node adapter
• Electron adapter
• Cloudflare Durable Object adapter
• Tauri adapter

Sync providers

• Cloudflare Workers
• ElectricSQL
• S2 : Use the official S2 backend with LiveStore via @livestore/sync-s2
• Build your own sync provider

Patterns

• Encryption
• Server-side clients
• Auth
• Effect
• Rich Text Editing
• External data
• List Ordering : Implement drag-and-drop list ordering with fractional indexing
• AI : How to use LiveStore to build AI applications
• Anonymous user transition : How to transition an anonymous user to a logged in user
• App evolution : How to evolve your app and roll out new app versions
• File management : How to manage files with LiveStore
• File structure
• ORM : How to use an ORM with LiveStore
• Offline support
• Presence : How to implement presence functionality with LiveStore
• Side effect : How to run side-effects for LiveStore events
• Storybook testing (React) : How to set up LiveStore with Storybook for component development and testing in React.
• Undo/Redo : How to implement undo/redo functionality with LiveStore
• Version control
• State machines : How to use state machines with LiveStore

Understanding LiveStore

• Event sourcing : Why and how LiveStore uses event sourcing for data flow, syncing and migrations.
• Design decisions : Design decisions and trade-offs made in the development of LiveStore

Sustainable open source

• Sponsoring LiveStore

Contributing

• Info : Notes for developers interested in contributing to LiveStore.
• Docs : Notes on contributing to the LiveStore docs
• Monorepo : Notes on the monorepo setup of LiveStore.

Miscellaneous

• Frequently asked questions : Frequently asked questions about LiveStore
• State of the project : A high-level overview of the current state of the project.
• Performance
• Community
• Troubleshooting : Common issues in apps using LiveStore and possible solutions.
• Credits : Credits and acknowledgements
• Resources : Resources, assets, logos, etc about LiveStore
• Design partners
• Code of conduct : Our code of conduct for the LiveStore community.
• Note on package management

npm packages

• Main package: @livestore/livestore@0.4.0-dev.22
• Framework integrations:
  • React: @livestore/react@0.4.0-dev.22
  • Solid: @livestore/solid@0.4.0-dev.22
• Platform adapters:
  • Web: @livestore/adapter-web@0.4.0-dev.22
  • Expo: @livestore/adapter-expo@0.4.0-dev.22
  • Node: @livestore/adapter-node@0.4.0-dev.22
• Sync provider:
  • Cloudflare: @livestore/sync-cf@0.4.0-dev.22
  • Electric: @livestore/sync-electric@0.4.0-dev.22
• Devtools:
  • Vite: @livestore/devtools-vite@0.4.0-dev.22
  • Expo: @livestore/devtools-expo@0.4.0-dev.22
• SQLite packages:
  • sqlite-wasm (wrapper around wa-sqlite): @livestore/sqlite-wasm@0.4.0-dev.22
  • wa-sqlite fork: @livestore/wa-sqlite@0.4.0-dev.22
• Internal packages:
  • @livestore/peer-deps@0.4.0-dev.22
  • @livestore/utils@0.4.0-dev.22
  • @livestore/common@0.4.0-dev.22