Overview #

The goal of this package is to make it easy to interact with Cloud Firestore API. The firefuel community aims to always make this package simple, intuitive, and consistent. firefuel wraps the cloud_firestore plugin, and provides conventions to help jump-start your development.

Still not convinced? See our documentation on why we thing you should choose firefuel

Scope #

firefuel focuses on simplifying the edge of your data layer, meaning this package pairs well with all ui, state management, model generation, and injection packages.

Quick Start #

We've created a base Repository and Collection for you to extend to your liking with the FirefuelRepository and FirefuelCollection.

The Repository is structurally reponsible for holding references to your main/top-level collection and any subcollections. The Repository is also logically responsible for ensuring all errors are caught and returned to your business logic layer as Either types.

See the firefuel documentation to walk through the core concepts of using firefuel.

See also: Handling Errors

Handling Errors Yourself #

No problem! Use the Collections on their own, and forget Repositories even exist. Handle errors how you are today without making the switch.

Getting Started #

Simply add the latest version of firefuel as a dependency in your pubspec.yaml file. Import package:firefuel/firefuel.dart into your entry point (often main.dart). Then, initialize firefuel using the Firefuel.initialize(FirebaseFirestore.instance); before calling runApp.

Read the full walkthrough in our docs.

Issues and feedback #

Please file all firefuel specific issues, bugs, or feature requests in our issue tracker

Please file FlutterFire specific issues, bugs, or feature requests in their issue tracker.

Plugin issues that are not specific to FlutterFire can be filed in the Flutter issue tracker.

Maintainers #

The maintainers for firefuel are Jonah Walker and Morgan Hunt

Logo Creator #

Our logo was created by Shawn Meek