Quick Start

Get your Flutter app connected to FlowConfig in under 2 minutes.

01

Create an account

Sign up for free at app.flowconfig.site.

02

Create a project

Once logged in, click New Project and enter your app's name.

03

Get your SDK key

Navigate to Settings > SDK Keys and copy your Production or Staging key.

04

Install the SDK

Add the package to your Flutter project:

yaml
90">dependencies:
  flowconfig_flutter: ^1.0.0
05

Initialize

Initialize the SDK in your main.dart before running your app.

dart
60">"text-white/80 font-medium">import 60">"text-white/60">'package:flowconfig_flutter/flowconfig.dart';

60">"text-white/80 font-medium">void main() 60">"text-white/80 font-medium">async {
  90">WidgetsFlutterBinding.90">ensureInitialized();
  
  60">"text-white/80 font-medium">await 90">FlowConfig.90">initialize(
    sdkKey: 60">"text-white/60">'fc_prod_xxxx', 40">// Replace with your actual key
    debugMode: true,        40">// Set to false in production
  );
  
  90">runApp(60">"text-white/80 font-medium">const 90">MyApp());
}
06

Read your first config

Create a config key in the FlowConfig dashboard:

  • Key: app_title
  • Type: String
  • Value: "Hello FlowConfig!"

Then, read it synchronously anywhere in your Flutter app:

dart
60">"text-white/80 font-medium">import 60">"text-white/60">'package:flowconfig_flutter/flowconfig.dart';

60">"text-white/80 font-medium">class 90">MyApp 60">"text-white/80 font-medium">extends 90">StatelessWidget {
  60">"text-white/80 font-medium">const 90">MyApp({super.key});

  @override
  Widget build(90">BuildContext context) {
    40">// Read the value synchronously. No FutureBuilder needed!
    60">"text-white/80 font-medium">final title = 90">FlowConfig.90">getString(60">"text-white/60">'app_title', defaultValue: 60">"text-white/60">'My App');
    
    60">"text-white/80 font-medium">return 90">MaterialApp(
      title: title,
      home: 90">Scaffold(
        appBar: 90">AppBar(title: 90">Text(title)),
        body: 90">Center(child: 90">Text(60">"text-white/60">'Welcome to $title')),
      ),
    );
  }
}

Run your app, and you'll see the title fetched straight from the dashboard. Change it on the dashboard, restart the app, and watch it update instantly without a new release!