Installation

Fluxy v1.2.1 introduces the Elite Motion system and Full-Width Glass Dock navigation. Update your core framework to access these high-end UI primitives.

1. Install Core Framework

The Fluxy core provides the Fluxy State System and essential building blocks.

dart pub add fluxy

2. Add Optional Modules

Fluxy's modular architecture lets you add only what you need:

dependencies:
  fluxy: ^1.2.1                    # Core framework (v1.2.1)
  fluxy_animations: ^1.2.1          # Elite animation primitives
  fluxy_auth: ^1.1.0                # Stable Authentication
  fluxy_camera: ^1.1.0              # Stable Camera
  fluxy_notifications: ^1.1.0       # Stable Notifications
  fluxy_storage: ^1.1.0             # Stable Storage
  # ... add only modules you use

3. Initialize a New Project

For a complete Fluxy architecture with all modules, use the CLI:

fluxy init my_awesome_app

3. Add Framework to Existing Project

If you already have a Flutter project, add the Fluxy framework via pub.dev.

flutter pub add fluxy

Alternatively, add it manually to your pubspec.yaml:

dependencies:
  fluxy: ^1.2.0

Elite Packages (v1.2.1)

With v1.2.1, Fluxy adopts the Elite UI standard. Add only the packages you need:

dependencies:
  # Core & Elite UI
  fluxy: ^1.2.1
  fluxy_animations: ^1.2.1
  
  # Add stable modules as needed (matching live pub.dev)
  fluxy_camera: ^1.1.0
  fluxy_auth: ^1.1.0
  fluxy_notifications: ^1.1.0
  fluxy_storage: ^1.1.0
  fluxy_websocket: ^1.1.0

Migration from v1.2.0

If you're upgrading to v1.2.1, check the migration guide for the new Elite UI features:

Read Migration Guide

Basic Setup

Import Fluxy in your Dart file:

import 'package:fluxy/fluxy.dart';

Global Initialization

In the Platform Era, initialization is two-fold: setting up the core engine and auto-registering installed modules.

void main() async {
  // 1. Initialize Fluxy Engine
  await Fluxy.init(); 
  
  // 2. Auto-register Platform Modules
  // This wires up all installed modules (auth, storage, etc.) automatically.
  Fluxy.autoRegister();
  
  runApp(const MyApp());
}

The Module Paradigm

Instead of just "plugins", Fluxy now uses Platform Modules. You can add them using the new CLI command:

fluxy module add auth
fluxy module add storage

This command handles installation and ensures they are picked up by Fluxy.autoRegister().

Wrapping your App

We recommend using FluxyApp (a pre-configured MaterialApp) or Fx builders for the best experience:

void main() async {
  await Fluxy.init();
  Fluxy.autoRegister();
  
  runApp(
    FluxyApp(
      title: "My App",
      initialRoute: HomeRoute(),
      routes: [HomeRoute(), SettingsRoute()],
    ),
  );
}

Now you're ready to start building with the Fluxy Platform!

Workspace & Monorepo Setup

If you are developing a modular ecosystem with multiple local packages, you should use the Workspace Authority tools:

1. Activate Melos (Industrial Management)

   dart pub global activate melos

2. Bootstrap the Workspace Connects all local modules (auth, storage, etc.) together:

   fluxy melos bootstrap

3. Verify Integrity Run the global analysis and test suite:

   fluxy melos run analyze
   fluxy melos run test

For more details on managing multiple packages, see the Workspace Authority guide.