Skip to Content
Getting StartedInstallation

Flutter InstantDB is a real-time, offline-first database client that provides reactive bindings for Flutter applications. It enables you to build collaborative, real-time applications with ease.

Requirements

  • Flutter SDK >= 3.8.0
  • Dart SDK >= 3.8.0
  • An InstantDB app ID (get one at instantdb.com )

Installation

Add Flutter InstantDB to your pubspec.yaml:

dependencies:
  flutter_instantdb: ^0.1.0

Or install from the command line:

flutter pub add flutter_instantdb

Platform Support

Flutter InstantDB supports all Flutter platforms:

PlatformSupportNotes
🤖 Android✅Full support with SQLite storage
🍎 iOS✅Full support with SQLite storage
🌐 Web✅IndexedDB storage with WebSocket sync
🖥️ macOS✅Full support with SQLite storage
🪟 Windows✅Full support with SQLite storage
🐧 Linux✅Full support with SQLite storage

Import

Add the import to your Dart files:

import 'package:flutter_instantdb/flutter_instantdb.dart';

Get Your App ID

  1. Visit instantdb.com  and create an account
  2. Create a new app
  3. Copy your App ID from the dashboard
  4. Store your App ID in a .env file in your project root: 
    INSTANTDB_APP_ID=your-app-id-here
  5. Use it in your Flutter app initialization

Next Steps

Now that you have InstantDB Flutter installed, let’s set up your first database connection:

Quick Start