Skip to content

Latest commit

 

History

History
 
 

docs

WatermelonDB Documentation

Get excited

  1. Check out the README for the "Why" and a quick example
  2. See the demo of Watermelon in action

Learn to use Watermelon

  1. Installation
  2. Schema
  3. Defining Models
  4. Create, Read, Update, Delete
  5. Connecting to React Components
  6. Querying - finding exactly what you need
  7. Relations
  8. Custom Actions

Advanced guides

  1. Migrations
  2. Sync
  3. Automatic create/update tracking
  4. Advanced fields — JSON, sanitizers
  5. Flow — using Watermelon with Flow
  6. LocalStorage
  7. Performance tips — TODO

Dig deeper into WatermelonDB

Details about how Watermelon works, how to hack and contribute:

  1. Architecture
  2. Adapters
  3. 📺 Digging deeper into WatermelonDB — more architectural info about caching, observation, and sync

Other

  1. Roadmap
  2. Contributing
  3. Changelog
  4. License