FFDB Documentation
FFDB gives you a typed database client, built-in auth, and optional offline sync across web, mobile, desktop, and Node.js apps. This documentation focuses on using the CLI and SDKs in real applications.
Use search in the header, or press Cmd/Ctrl + K, to jump directly to any page.
What you need
Before you start, make sure you have:
- Node.js and npm installed.
- An FFDB app created in the dashboard.
- Your FFDB app URL and admin token for local setup tasks like type generation.
Keep admin tokens in trusted environments only. Do not ship admin credentials in browser bundles.
Choose your path
- Name
Fastest start: scaffold with CLI- Description
Run
ffdb-cli initto generate a starter app, thenffdb-cli generateto produce your typed schema file.
- Name
Manual start: add SDK to existing app- Description
Install
ffdb-client, configureapiUrl, sign in users, and query with typed helpers.
- Name
Framework-specific setup- Description
Use the React, Next.js, Expo, Node.js, and Electron guides when you need runtime-specific setup patterns.
Suggested reading order
Resources
Client
Create and manage the FFDB client across environments. Configure connections, lifecycle, and cleanup.
Database
Query, insert, update, and delete data using the type-safe query builder or raw SQL.
Auth
User authentication, sessions, admin tokens, and automatic API key rotation.
Sync
Offline-first data flow with local cache, mutation queue, and background synchronization.
Configuration
Environment variables, storage adapters, network handling, and runtime options.
Type generation
Generate and maintain TypeScript types from your database schema for full type safety.