Docs
Getting Started Learn how to get started with LiveStore
Evaluation Evaluate LiveStore for your use case
Reference Reference documentation for LiveStore
Patterns A collection of patterns for using LiveStore in different scenarios
Community Community resources for LiveStore
Contributing Contributing to LiveStore
State of the documentation
Section titled “State of the documentation”Please note that the documentation is still work in progress with many parts missing and often only containing notes/bullet points.
Docs for LLMs
Section titled “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
- Docs : Notes on contributing to the LiveStore docs
- Contributing : Notes for developers interested in contributing to LiveStore.
- Docs
- Monorepo : Notes on the monorepo setup of LiveStore.
- AI agent : How to model an AI agent in LiveStore.
- Data Modeling : How to model data in LiveStore.
- Complex UI state : How to model complex UI state in LiveStore.
- Todo app with shared workspaces : How to model a todo workspace app with shared workspaces in LiveStore.
- Turn-based game : How to model a turn-based game in LiveStore.
- Design Decisions : Design decisions and trade-offs made in the development of LiveStore
- Event Sourcing : Why and how LiveStore uses event sourcing for data flow, syncing and migrations.
- Performance
- How LiveStore works
- State of the project : A high-level overview of the current state of the project.
- Technology comparison : How LiveStore compares to other related technologies
- When to use LiveStore (and when not) : Considerations when deciding to use LiveStore.
- Cloudflare Durable Objects Examples : LiveStore examples built with the Cloudflare adapter for edge computing and Durable Objects
- Expo Adapter Examples : LiveStore examples built with the Expo adapter for React Native mobile applications
- Examples : Explore LiveStore example applications across different platforms and use cases
- Node Adapter Examples : LiveStore examples built with the Node adapter for server-side environments
- Web Adapter Examples : LiveStore examples built with the Web adapter for browser environments
- Expo : Learn how to use LiveStore with Expo.
- Node : Learn how to use LiveStore with Node.
- Getting started with LiveStore + React : How to use LiveStore with React on the web.
- Solid : Learn how to use LiveStore with Solid.
- Getting started with LiveStore + Vue : How to use LiveStore with Vue.
- Frequently Asked Questions : Frequently asked questions about LiveStore
- Code of Conduct : Our code of conduct for the LiveStore community.
- Community
- Credits : Credits and acknowledgements
- Note on Package Management
- Design Partners
- Resources : Resources, assets, logos, etc about LiveStore
- Sponsoring LiveStore
- Anonymous user transition : How to transition an anonymous user to a logged in user
- Auth
- Effect
- Encryption
- External Data
- 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.
- AI : How to use LiveStore to build AI applications
- File Management : How to manage files with LiveStore
- ORM : How to use an ORM with LiveStore
- Rich Text Editing
- State Machines : How to use state machines with LiveStore
- Undo/Redo : How to implement undo/redo functionality with LiveStore
- File Structure
- App Evolution : How to evolve your app and roll out new app versions
- Offline Support
- Troubleshooting : Common issues in apps using LiveStore and possible solutions.
- LiveStore CLI : Command-line interface for LiveStore project scaffolding and development tools.
- Debugging a LiveStore app
- Concepts : Concepts in LiveStore
- Version control
- Devtools
- Events
- MCP Integration : Model Context Protocol integration for AI assistants like Claude.
- OpenTelemetry
- Reactivity System
- Store
- Custom Elements : How to integrate LiveStore with Custom Elements aka Web Components.
- Solid integration : How to integrate LiveStore with Solid.
- React integration for LiveStore : How to integrate LiveStore with React.
- Cloudflare Durable Object Adapter
- Electron Adapter
- Node Adapter
- Tauri Adapter
- Materializers
- Web Adapter : Information about LiveStore's web adapter
- SQL Queries
- SQLite State Schema (Effect Schema)
- SQLite State Schema
- SQLite in LiveStore : Notes on how to use SQLite in LiveStore
- Syncing
- Server-side clients
- Expo Adapter
- Vue integration for LiveStore : How to integrate LiveStore with Vue.
- Cloudflare Workers
- Build your own sync provider
- S2 : Use the official S2 backend with LiveStore via @livestore/sync-s2
- ElectricSQL
NPM packages
Section titled “NPM packages”- Main package:
@livestore/livestore@0.4.0-dev.14 - Framework integrations:
- React:
@livestore/react@0.4.0-dev.14 - Solid:
@livestore/solid@0.4.0-dev.14
- React:
- Platform adapters:
- Sync provider:
- Cloudflare:
@livestore/sync-cf@0.4.0-dev.14 - Electric:
@livestore/sync-electric@0.4.0-dev.14
- Cloudflare:
- Devtools:
- SQLite packages:
- sqlite-wasm (wrapper around wa-sqlite):
@livestore/sqlite-wasm@0.4.0-dev.14 - wa-sqlite fork:
@livestore/wa-sqlite@0.4.0-dev.14
- sqlite-wasm (wrapper around wa-sqlite):
- Internal packages: