Skip to content
pubscout

flamingo

3.0.0, released 4 years ago by neverjp.com

Firebase Firestore model framework library with code generation for Dart.

$ flutter pub add flamingo
Source repository

What it does

Provides an object-model mapping framework for Firebase Firestore and Cloud Storage. It maps Firestore documents and collections to Dart classes using annotations and build_runner, supporting sub-collections, paging, caching, and batch operations.

AI-written summary of version 3.0.0, based on the package's README and metadata. Report an inaccuracy

Use it when

  • You are building a Flutter app heavily integrated with Cloud Firestore and want structured models.
  • You want automatic JSON mapping for Firestore documents using annotations.
  • You need built-in handling for sub-collections, batch writes, transactions, and collection paging.

Skip it when

  • You are using a backend other than Firebase Firestore.
  • You prefer writing raw Map-based Firestore queries without schema models.

Strengths

  • Simplifies Firestore CRUD operations via DocumentAccessor, Batch, and Transaction.
  • Code generation helps keep models and data mapping boilerplate-free.
  • Supports collection paging, caching, and sub-collections natively.

Weaknesses

  • Requires running build_runner for code generation.
  • Tight coupling to Cloud Firestore.

Setup

Kind
Flutter widgets
Effort
Medium
Code generation
Yes (build_runner)
Direct dependencies
5

Requires setting up cloud_firestore, adding flamingo and flamingo_annotation to dependencies, and flamingo_generator with build_runner to dev_dependencies. Initialize with Flamingo.initializeApp().

import 'package:flamingo/flamingo.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await Flamingo.initializeApp();
}

Alternatives

Packages that do the same job and could replace flamingo.

Works with

Packages commonly used together with flamingo: ones it builds on, ones built on it, and its own family.