Skip to content

Installation

Add Fasq to your Flutter project. You can use the core package alone or add one of the optimized adapters for your preferred state management solution.

The core package provides the QueryBuilder, MutationBuilder, and all underlying caching functionality.

Terminal window
flutter pub add fasq

If you are already using a state management library, we highly recommend using the corresponding adapter for a more integrated and idiomatic experience.

Terminal window
flutter pub add fasq_riverpod
Terminal window
flutter pub add fasq_bloc
Terminal window
flutter pub add fasq_hooks

For enterprise-grade encryption and secure SQL persistence:

Terminal window
flutter pub add fasq_security

To automate type-safe query serialization and eliminate boilerplate:

Terminal window
flutter pub add -d fasq_serializer_generator build_runner
  1. Install the dependencies using the commands above.
  2. Import the packages in your Dart files:
  3. Import the packages you need:
// Core package
import 'package:fasq/fasq.dart';
// Adapters (if using)
// import 'package:fasq_hooks/fasq_hooks.dart';
// import 'package:fasq_bloc/fasq_bloc.dart';
// import 'package:fasq_riverpod/fasq_riverpod.dart';

Fasq requires:

  • Flutter: 3.10.0 or higher
  • Dart: 3.0.0 or higher