Getting Started
Installation
How to install Flutter InstantDB
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.0Or install from the command line:
flutter pub add flutter_instantdbdart pub add flutter_instantdbPlatform Support
Flutter InstantDB supports all Flutter platforms:
| Platform | Support | Notes |
|---|---|---|
| ๐ค 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
- Visit instantdb.com and create an account
- Create a new app
- Copy your App ID from the dashboard
- Store your App ID in a
.envfile in your project root:INSTANTDB_APP_ID=your-app-id-here - 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 Guide - Create your first real-time app
- Database Setup - Initialize and configure your database
- Schema Definition - Define your data structure