Local Config #

Make changes to your app's default behavior and appearance by changing parameter values — just like Firebase Remote Config, but locally. It’s designed for teams that need flexibility to override parameters, test feature flags, and simulate Remote Config behavior directly on their devices.

Features #

The main goal is to provide the ability to manage configs locally for any purpose during development, testing, and even staging workflows.

• Familiar API inspired by Firebase Remote Config (onConfigUpdated, getBool, getString, etc)
• Built-in widget, also inspired by Firebase Remote Config, for viewing/editing parameter values
• Persistent parameter value overrides using shared_preferences or flutter_secure_storage

Getting Started #

Add dependency

dependencies:
  local_config: ^0.0.2

Initialize with your parameters

import 'package:flutter/material.dart';
import 'package:local_config/local_config.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  await LocalConfig.instance.initialize(
    parameters: {
        'feature_enabled': 'true',
        'api_base_url': 'https://api.myapp.com/v1',
        'retry_attempts': '3',
        'animation_speed': '1.25',
        'theme': '{"seedColor": "#2196F3", "darkMode": false}',
    },
  );

  runApp(const ExampleApp());
}

Or with the FirebaseRemoteConfig parameters

import 'package:flutter/material.dart';
import 'package:firebase_remote_config/firebase_remote_config.dart';
import 'package:local_config/local_config.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  await FirebaseRemoteConfig.instance.fetchAndActivate();

  await LocalConfig.instance.initialize(
    defaults: FirebaseRemoteConfig.instance.getAll().map(
      (key, value) => MapEntry(key, value.asString()),
    ),
  );

  runApp(const ExampleApp());
}

Navigate to built-in entrypoint widget

IconButton(
  onPressed: () {
    Navigator.of(context).push(
      MaterialPageRoute(
        builder: (_) => LocalConfig.instance.entrypoint,
      ),
    );
  },
  tooltip: 'Local Config',
  icon: const Icon(Icons.settings),
)

Get parameter values

final featureEnabled = LocalConfig.instance.getBool('feature_enabled');
final apiBaseUrl = LocalConfig.instance.getString('api_base_url');
final retryAttempts = LocalConfig.instance.getInt('retry_attempts');
final animatinoSpeed = LocalConfig.instance.getDouble('animation_speed');
final theme = LocalConfig.instance.getString('theme');

Or listen for updates (if your implementation supports it)

LocalConfig.instance.onConfigUpdated.listen((configs) {
  print('Configs updated: $configs');
});

For a full demo, check the example folder.

Additional Information #

• Report issues or request features in the GitHub Issues
• Contributions are welcome! Feel free to open pull requests.