Guides

The Basics

These guides cover the very basics of TinyBase. Read more.

• Getting Started
• Creating A Store
• Writing To Stores
• Reading From Stores
• Listening To Stores
• Transactions
• Importing TinyBase
• TinyBase And TypeScript
• Architectural Options

Building UIs

These guides cover how to use the ui-react module and use React hooks and components to easily build reactive user interfaces with TinyBase. Read more.

• Getting Started With ui-react
• Using React Hooks
• Using React Components
• Using React DOM Components
• Using Context

Schemas

These guides discuss how to set up a ValuesSchema or TablesSchema on a Store so that certain structures of data are assured. Read more.

• Using Schemas
• Schema-Based Typing
• Mutating Data With Listeners

Persistence

These guides discuss how to load and save data to a Store from a persistence layer. Read more.

• An Intro To Persistence
• Database Persistence
• Third-Party CRDT Persistence
• Custom Persistence

Synchronization

These guides discuss how to merge and synchronize data in MergeableStore instances using synchronization techniques. Read more.

• Using A MergeableStore
• Using A Synchronizer

Integrations

There are plenty of other projects, products, and platforms that TinyBase can work with and alongside. Read more.

• Cloudflare Durable Objects

Using Metrics

These guides discuss how to define Metrics that aggregate values together. Read more.

• An Intro To Metrics
• Building A UI With Metrics
• Advanced Metric Definition

Using Indexes

These guides discuss how to define Indexes that allow fast access to matching Row objects. Read more.

• An Intro To Indexes
• Building A UI With Indexes
• Advanced Index Definition

Using Relationships

These guides discuss how to define Relationships that connect Rows together between Table objects. Read more.

• An Intro To Relationships
• Building A UI With Relationships
• Advanced Relationship Definitions

Using Checkpoints

These guides discuss how to use Checkpoints that allow you to build undo and redo functionality. Read more.

• An Intro To Checkpoints
• Building A UI With Checkpoints

Using Queries

These guides discuss how to define queries that let you select specific Row and Cell combinations from each Table, and benefit from powerful features like grouping and aggregation. Read more.

• An Intro To Queries
• TinyQL
• Building A UI With Queries

Developer Tools

These guides discuss the developer tools that are available in TinyBase. These are not intended for production use, but are instead to be used as part of your engineering workflow to perform tasks like generating APIs from schemas, or schemas from data. Read more.

• Inferring TablesSchemas
• Generating APIs
• Gathering Statistics
• Command Line
• Inspecting Data

How TinyBase Is Built

These guides discuss how TinyBase is structured and some of the interesting ways in which it is architected, tested, and built. Read more.

• Developing TinyBase
• Architecture
• Testing
• Documentation
• How The Demos Work
• Credits

FAQ

These are some of the frequently asked questions about TinyBase. Read more.

Releases

This is a reverse chronological list of the major TinyBase releases, with highlighted features. Read more.