Index of every page on this site: llms.txt
All skills
flutter avatar

/flutter-apply-architecture-best-practices

@ff6d472 official
by flutterflutter/agent-plugins3.2k stars
193
Run it yourself

Architects a Flutter application using the recommended layered approach (UI, Logic, Data). Use when structuring a new project or refactoring for scalability.

Use this Skill: https://skilld.dev/gh/flutter/agent-plugins/flutter-apply-architecture-best-practices

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈50 tokens for metadata: the name and description. ≈1.5k when used: this file.

Description uses 2.5% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈201 characters, or 2.5%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

Architecting Flutter Applications

Contents

Architectural Layers

Enforce strict Separation of Concerns by dividing the application into distinct layers. Never mix UI rendering with business logic or data fetching.

UI Layer (Presentation)

Implement the MVVM (Model-View-ViewModel) pattern to manage UI state and logic.

  • Views: Write reusable, lean widgets. Restrict logic in Views to UI-specific operations (e.g., animations, layout constraints, simple routing). Pass all required data from the ViewModel.
  • ViewModels: Manage UI state and handle user interactions. Extend ChangeNotifier (or use Listenable) to expose state. Expose immutable state snapshots to the View. Inject Repositories into ViewModels via the constructor.

Data Layer

Implement the Repository pattern to isolate data access logic and create a single source of truth.

  • Services: Create stateless classes to wrap external APIs (HTTP clients, local databases, platform plugins). Return raw API models or Result wrappers.
  • Repositories: Consume one or more Services. Transform raw API models into clean Domain Models. Handle caching, offline synchronization, and retry logic. Expose Domain Models to ViewModels.

Logic Layer (Domain - Optional)

  • Use Cases: Implement this layer only if the application contains complex business logic that clutters the ViewModel, or if logic must be reused across multiple ViewModels. Extract this logic into dedicated Use Case (interactor) classes that sit between ViewModels and Repositories.

Project Structure

Organize the codebase using a hybrid approach: group UI components by feature, and group Data/Domain components by type.

lib/
├── data/
│   ├── models/         # API models
│   ├── repositories/   # Repository implementations
│   └── services/       # API clients, local storage wrappers
├── domain/
│   ├── models/         # Clean domain models
│   └── use_cases/      # Optional business logic classes
└── ui/
    ├── core/           # Shared widgets, themes, typography
    └── features/
        └── [feature_name]/
            ├── view_models/
            └── views/

Workflow: Implementing a New Feature

Follow this sequential workflow when adding a new feature to the application. Copy the checklist to track progress.

Task Progress

  • Step 1: Define Domain Models. Create immutable data classes for the feature using freezed or built_value.
  • Step 2: Implement Services. Create or update Service classes to handle external API communication.
  • Step 3: Implement Repositories. Create the Repository to consume Services and return Domain Models.
  • Step 4: Apply Conditional Logic (Domain Layer).
    • If the feature requires complex data transformation or cross-repository logic: Create a Use Case class.
    • If the feature is a simple CRUD operation: Skip to Step 5.
  • Step 5: Implement the ViewModel. Create the ViewModel extending ChangeNotifier. Inject required Repositories/Use Cases. Expose immutable state and command methods.
  • Step 6: Implement the View. Create the UI widget. Use ListenableBuilder or AnimatedBuilder to listen to ViewModel changes.
  • Step 7: Inject Dependencies. Register the new Service, Repository, and ViewModel in the dependency injection container (e.g., provider or get_it).
  • Step 8: Run Validator. Execute unit tests for the ViewModel and Repository.
    • Feedback Loop: Run tests -> Review failures -> Fix logic -> Re-run until passing.

Examples

Data Layer: Service and Repository

// 1. Service (Raw API interaction)
class ApiClient {
  Future<UserApiModel> fetchUser(String id) async {
    // HTTP GET implementation...
  }
}

// 2. Repository (Single source of truth, returns Domain Model)
class UserRepository {
  UserRepository({required ApiClient apiClient}) : _apiClient = apiClient;
  
  final ApiClient _apiClient;
  User? _cachedUser;

  Future<User> getUser(String id) async {
    if (_cachedUser != null) return _cachedUser!;
    
    final apiModel = await _apiClient.fetchUser(id);
    _cachedUser = User(id: apiModel.id, name: apiModel.fullName); // Transform to Domain Model
    return _cachedUser!;
  }
}

UI Layer: ViewModel and View

// 3. ViewModel (State management and presentation logic)
class ProfileViewModel extends ChangeNotifier {
  ProfileViewModel({required UserRepository userRepository}) 
      : _userRepository = userRepository;

  final UserRepository _userRepository;

  User? _user;
  User? get user => _user;

  bool _isLoading = false;
  bool get isLoading => _isLoading;

  Future<void> loadProfile(String id) async {
    _isLoading = true;
    notifyListeners();

    try {
      _user = await _userRepository.getUser(id);
    } finally {
      _isLoading = false;
      notifyListeners();
    }
  }
}

// 4. View (Dumb UI component)
class ProfileView extends StatelessWidget {
  const ProfileView({super.key, required this.viewModel});

  final ProfileViewModel viewModel;

  @override
  Widget build(BuildContext context) {
    return ListenableBuilder(
      listenable: viewModel,
      builder: (context, _) {
        if (viewModel.isLoading) {
          return const Center(child: CircularProgressIndicator());
        }
        
        final user = viewModel.user;
        if (user == null) {
          return const Center(child: Text('User not found'));
        }

        return Column(
          children: [
            Text(user.name),
            ElevatedButton(
              onPressed: () => viewModel.loadProfile(user.id),
              child: const Text('Refresh'),
            ),
          ],
        );
      },
    );
  }
}

Source: SKILL.md on GitHub

No rule matched.

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No alerts4mo3 checks · Risk SAFE
  • Gen Agent Trust Hub4mo

    This skill provides architectural guidelines and best practices for structuring Flutter applications using a layered approach (UI, Logic, Data). It includes project structure recommendations and code examples following standard design patterns like MVVM and Repository.

  • Socket4mo

    No alerts

  • Snyk4mo

    Risk: LOW · No issues

Signed by skilld at ff6d472. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub yesterday.

Activeupdated 7 months ago
Other metadata
metadata
{
  "model": "models/gemini-3.1-pro-preview",
  "last_modified": "Tue, 21 Apr 2026 20:11:20 GMT"
}
  • flutter
  • architecture
  • mvvm
  • repository-pattern
  • layered-architecture
  • state-management
  • project-structure
  • separation-of-concerns
  • domain-driven-design

README badge

README badge for flutter/agent-plugins/flutter-apply-architecture-best-practices

Structures Flutter applications using a layered MVVM architecture with strict separation between UI (Views/ViewModels), Data (Services/Repositories), and optional Logic (Use Cases) layers. Provides a feature-based project structure, a step-by-step workflow for implementing new features, and concrete examples using ChangeNotifier for state management.

Generated from the current SKILL.md.

Does this skill enforce a specific state management library?
No. The skill uses ChangeNotifier and ListenableBuilder as examples, but you can substitute with other state management solutions like Riverpod or BLoC. The layered architecture pattern itself is framework-agnostic.
When should I create a Use Case class versus putting logic directly in the ViewModel?
Create a Use Case if the feature has complex data transformation or logic that must be reused across multiple ViewModels. For simple CRUD operations, keep the logic in the ViewModel.
Does this skill cover dependency injection setup?
The skill mentions registering dependencies in a container like `provider` or `get_it`, but does not provide detailed setup instructions for either library.
Can I apply this architecture to an existing Flutter project?
Yes. The skill is designed for both new projects and refactoring existing applications for scalability. The workflow steps apply incrementally as you add or restructure features.

Generated from the current SKILL.md. These answers refresh after source changes.