feat(template): comprehensive update with modern tools and architecture

# Core Architecture & State Management
- feat(state): implement Hooks Riverpod with code generation for reactive programming
  • Add custom React Query-inspired hooks system (useQuery, useInfiniteQuery, useAsyncTask)
  • Implement provider observers for debugging state changes
  • Create product providers with comprehensive state management
- feat(routing): replace AutoRoute with GoRouter for enhanced navigation
  • Add custom PopNotifier to fix state refresh issues on pop events
  • Implement RoutePage for consistent navigation behavior
  • Create router state provider for reactive routing state access

# API & Data Layer
- feat(api): build comprehensive API infrastructure with Dio
  • Implement centralized error handling via custom ApiService
  • Create repository pattern with clean data layer organization
  • Add mocked API clients for testing without backend
- feat(models): add type-safe data models with freezed
  • Create product DTOs with serialization/deserialization
  • Implement proper error handling and data validation

# UI Components & Screens
- feat(ui): develop advanced scaffolding system
  • Create root scaffold with config provider for separation of concerns
  • Implement page scaffold with smart drawer delegation
  • Add proper focus and gesture management across nested navigators
- feat(demo): add comprehensive demo screens showcasing key features
  • Create screens for components, i18n, navigation, queries and mutations
  • Implement infinite scrolling with both provider and query approaches
  • Add product card and dialog components for real-world examples

# Development Environment & Tooling
- feat(git): add linguist-generated attributes for generated Dart files [improve repository classification]
- feat(husky): implement commit-msg and pre-commit hooks for code quality
  • Enforce standardized commit messages with commitlint_cli
  • Validate pubspec exact versioning on pre-commit
  • Execute lint_staged for staged files
- feat(vscode): enhance developer experience with custom settings
  • Add recommended extensions for Dart/Flutter development
  • Configure i18n-ally for custom framework integration
  • Set file nesting patterns for generated Dart files
  • Adjust Dart line length to 120 characters
- feat(build): configure code generation tools for assets(flutter_gen) and i18n(slang with comprehensive i18n generation options)

# Documentation & Project Structure
- feat(README): revamp documentation with modern template features
  • Update project description and badges to reflect latest supported versions
  • Add detailed sections for state management, routing, networking, and UI components
  • Include comprehensive project structure with detailed explanations
  • Add useful commands and tech stack resources

# Platform Configuration
- feat(android): modernize build system and configuration according to latest flutter updates
  • Switch to kotlin configuration files
  • Configure NDK version and Java compatibility settings
  • Add deep linking and intent handling in AndroidManifest.xml
- feat(ios): update iOS platform configuration according to latest flutter updates
  • Increase minimum iOS version to 12.0
  • Update XCode project settings and Pod dependencies
  • Add i18n config in info.plist

# Internationalization & Assets
- feat(i18n): implement comprehensive translation system using Slang
  • Replace easy_localization with type-safe Slang implementation
  • Add English and French translations with examples for various scenarios (pluralization, gender-specific content, rich text...)
- feat(assets): implement type-safe asset access with Flutter Gen
  • Add demo SVG icons and example resources
  • Add example launcher icons and and splash screen Android and iOS configurations

# Code Cleanup & Modernization
- refactor(legacy): remove outdated patterns and dependencies
  • Replace BLoC pattern with Hooks Riverpod
  • Remove custom storage implementations in favor of typed providers
  • Clean up unused widgets and utilities
- chore(deps): update all dependencies to latest versions
  • Ensure compatibility with Flutter 3.29+ and Dart 3.7+

This comprehensive update transforms the template into a production-ready Flutter starter with modern architecture patterns, enhanced developer tooling, and improved internationalization support. The template now provides a solid foundation for building scalable and maintainable mobile applications with industry best practices, real implementations of key patterns, working examples, and extensive documentation.

Author: ouedyan

.gitattributes

@@ -0,0 +1,4 @@
+*.g.dart linguist-generated=true
+*.freezed.dart linguist-generated=true
+*.tailor.dart linguist-generated=true
+*.gen.dart linguist-generated=true

.gitignore

@@ -5,16 +5,21 @@
 *.swp
 .DS_Store
 .atom/
+.build/
 .buildlog/
 .history
 .svn/
+.swiftpm/
 migrate_working_dir/
 
 # IntelliJ related
 *.iml
 *.ipr
 *.iws
 .idea/
+!/.idea/easy-i18n.xml
+!/.idea/codeStyles/codeStyleConfig.xml
+!/.idea/codeStyles/Project.xml
 
 # The .vscode folder contains launch configuration and tasks you configure in
 # VS Code which you may wish to be included in version control, so this line
@@ -27,14 +32,10 @@ migrate_working_dir/
 .dart_tool/
 .flutter-plugins
 .flutter-plugins-dependencies
-.packages
 .pub-cache/
 .pub/
 /build/
 
-# Web related
-lib/generated_plugin_registrant.dart
-
 # Symbolication related
 app.*.symbols
 

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+dart run commitlint_cli --edit "${1}"

.husky/pre-commit

@@ -0,0 +1,8 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+# Enforce pubspec exact versioning for dependencies
+git diff --cached --name-only | grep -q 'pubspec.yaml' && dart run tool/validate_pubspec_versions.dart
+
+# Run lint_staged
+dart run lint_staged

.metadata

@@ -1,26 +1,26 @@
 # This file tracks properties of this Flutter project.
 # Used by Flutter tool to assess capabilities and perform upgrades etc.
 #
-# This file should be version controlled.
+# This file should be version controlled and should not be manually edited.
 
 version:
-  revision: cd41fdd495f6944ecd3506c21e94c6567b073278
-  channel: stable
+  revision: "c519ee916eaeb88923e67befb89c0f1dabfa83e6"
+  channel: "stable"
 
 project_type: app
 
 # Tracks metadata for the flutter migrate command
 migration:
   platforms:
     - platform: root
-      create_revision: cd41fdd495f6944ecd3506c21e94c6567b073278
-      base_revision: cd41fdd495f6944ecd3506c21e94c6567b073278
+      create_revision: c519ee916eaeb88923e67befb89c0f1dabfa83e6
+      base_revision: c519ee916eaeb88923e67befb89c0f1dabfa83e6
     - platform: android
-      create_revision: cd41fdd495f6944ecd3506c21e94c6567b073278
-      base_revision: cd41fdd495f6944ecd3506c21e94c6567b073278
+      create_revision: c519ee916eaeb88923e67befb89c0f1dabfa83e6
+      base_revision: c519ee916eaeb88923e67befb89c0f1dabfa83e6
     - platform: ios
-      create_revision: cd41fdd495f6944ecd3506c21e94c6567b073278
-      base_revision: cd41fdd495f6944ecd3506c21e94c6567b073278
+      create_revision: c519ee916eaeb88923e67befb89c0f1dabfa83e6
+      base_revision: c519ee916eaeb88923e67befb89c0f1dabfa83e6
 
   # User provided section
 

.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+  "recommendations": [
+    "dart-code.dart-code",
+    "dart-code.flutter",
+    "robert-brunhage.flutter-riverpod-snippets",
+    "lokalise.i18n-ally"
+  ]
+}

.vscode/i18n-ally-custom-framework.yml

@@ -0,0 +1,26 @@
+# Language Ids that should be scanned for translations
+languageIds:
+  - dart
+  - yaml
+  - json
+
+# RegEx patterns to detect translation key usage
+# The {key} placeholder will be replaced with the proper keypath matching regex
+usageMatchRegex:
+  # Match t.some.path and t['some.path']
+  - "\\bt\\.({key})" # TODO: Does not work, probably because the key is no more a string
+  - "\\bt\\[['\"`]({key})['\"`]"
+  # Match double braces interpolation {{param}}
+  # - "\\{\\{({key})\\}\\}"
+
+# A RegEx to detect scopes from imports and usage
+# This matches the import of the generated translations file
+# scopeRangeRegex: "import.*translations\\.g\\.dart"
+
+# Set to true to only use this custom framework
+monopoly: true
+
+# Templates used when refactoring/inserting new keys
+refactorTemplates:
+  - t.$1
+  - t['$1']

.vscode/settings.json

@@ -0,0 +1,15 @@
+{
+  "explorer.fileNesting.patterns": {
+    "*.dart": "${capture}.g.dart, ${capture}.freezed.dart, ${capture}.tailor.dart, ${capture}.gen.dart"
+  },
+  "i18n-ally.enabledFrameworks": ["custom"],
+  "i18n-ally.annotationDelimiter": ".",
+  "i18n-ally.keystyle": "nested",
+  "i18n-ally.localesPaths": "assets/i18n",
+  "i18n-ally.namespace": true,
+  "i18n-ally.sortKeys": true,
+  "dart.lineLength": 120,
+  "[dart]": {
+    "editor.rulers": [120]
+  }
+}