maxsim-flutter 1.0.0

package/templates/modules/auth/lib/features/auth/presentation/providers/auth_provider.dart.hbs

@@ -0,0 +1,31 @@
+import 'package:flutter_riverpod/flutter_riverpod.dart';
+import 'package:riverpod_annotation/riverpod_annotation.dart';
+import '../../data/datasources/auth_remote_datasource.dart';
+import '../../data/repositories/auth_repository_impl.dart';
+import '../../domain/entities/user_entity.dart';
+import '../../domain/repositories/auth_repository.dart';
+
+part 'auth_provider.g.dart';
+
+@riverpod
+AuthRemoteDataSource authDataSource(Ref ref) {
+{{#ifEquals modules.auth.provider "firebase"}}
+  return FirebaseAuthDataSource();
+{{/ifEquals}}
+{{#ifEquals modules.auth.provider "supabase"}}
+  return SupabaseAuthDataSource();
+{{/ifEquals}}
+{{#ifEquals modules.auth.provider "custom"}}
+  return CustomAuthDataSource();
+{{/ifEquals}}
+}
+
+@riverpod
+AuthRepository authRepository(Ref ref) {
+  return AuthRepositoryImpl(ref.watch(authDataSourceProvider));
+}
+
+@riverpod
+Stream<UserEntity?> authState(Ref ref) {
+  return ref.watch(authRepositoryProvider).authStateChanges;
+}

package/templates/modules/auth/pubspec.partial.yaml

@@ -0,0 +1,13 @@
+{{#ifEquals modules.auth.provider "firebase"}}
+dependencies:
+  firebase_core: ^3.8.0
+  firebase_auth: ^5.3.4
+{{/ifEquals}}
+{{#ifEquals modules.auth.provider "supabase"}}
+dependencies:
+  supabase_flutter: ^2.8.2
+{{/ifEquals}}
+{{#ifEquals modules.auth.provider "custom"}}
+dependencies:
+  dio: ^5.7.0
+{{/ifEquals}}

package/templates/modules/cicd/.github/workflows/ci.yml.hbs

@@ -0,0 +1,45 @@
+{{#ifEquals modules.cicd.provider "github"}}
+name: CI
+
+on:
+  push:
+    branches: [main, develop]
+  pull_request:
+    branches: [main, develop]
+
+jobs:
+  flutter:
+    name: Flutter CI
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Flutter
+        uses: subosito/flutter-action@v2
+        with:
+          flutter-version: 'stable'
+          channel: 'stable'
+          cache: true
+
+      - name: Install dependencies
+        run: flutter pub get
+
+      - name: Verify formatting
+        run: dart format --output=none --set-exit-if-changed .
+
+      - name: Analyze code
+        run: flutter analyze --fatal-infos
+
+      - name: Run tests
+        run: flutter test --coverage
+
+      - name: Build Android APK
+        run: flutter build apk --debug
+
+      - name: Upload coverage
+        uses: codecov/codecov-action@v4
+        with:
+          file: coverage/lcov.info
+{{/ifEquals}}

package/templates/modules/cicd/.gitlab-ci.yml.hbs

@@ -0,0 +1,53 @@
+{{#ifEquals modules.cicd.provider "gitlab"}}
+image: ghcr.io/cirruslabs/flutter:stable
+
+stages:
+  - validate
+  - test
+  - build
+
+variables:
+  PUB_CACHE: "$CI_PROJECT_DIR/.pub-cache"
+
+cache:
+  key: "$CI_COMMIT_REF_SLUG"
+  paths:
+    - .pub-cache/
+    - .dart_tool/
+
+format:
+  stage: validate
+  script:
+    - flutter pub get
+    - dart format --output=none --set-exit-if-changed .
+
+analyze:
+  stage: validate
+  script:
+    - flutter pub get
+    - flutter analyze --fatal-infos
+
+test:
+  stage: test
+  script:
+    - flutter pub get
+    - flutter test --coverage
+  artifacts:
+    reports:
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage/cobertura.xml
+
+build_apk:
+  stage: build
+  script:
+    - flutter pub get
+    - flutter build apk --debug
+  artifacts:
+    paths:
+      - build/app/outputs/flutter-apk/app-debug.apk
+    expire_in: 1 week
+  only:
+    - main
+    - develop
+{{/ifEquals}}

package/templates/modules/cicd/bitbucket-pipelines.yml.hbs

@@ -0,0 +1,39 @@
+{{#ifEquals modules.cicd.provider "bitbucket"}}
+image: ghcr.io/cirruslabs/flutter:stable
+
+pipelines:
+  default:
+    - step:
+        name: Validate & Test
+        caches:
+          - gradle
+        script:
+          - flutter pub get
+          - dart format --output=none --set-exit-if-changed .
+          - flutter analyze --fatal-infos
+          - flutter test --coverage
+
+  branches:
+    main:
+      - step:
+          name: Validate & Test
+          script:
+            - flutter pub get
+            - flutter analyze --fatal-infos
+            - flutter test --coverage
+      - step:
+          name: Build Android APK
+          script:
+            - flutter pub get
+            - flutter build apk --debug
+          artifacts:
+            - build/app/outputs/flutter-apk/*.apk
+
+    develop:
+      - step:
+          name: Validate & Test
+          script:
+            - flutter pub get
+            - flutter analyze --fatal-infos
+            - flutter test --coverage
+{{/ifEquals}}

package/templates/modules/cicd/pubspec.partial.yaml

@@ -0,0 +1 @@
+# CI/CD module has no pubspec dependencies

package/templates/modules/database/lib/features/database/data/datasources/database_datasource.dart.hbs

@@ -0,0 +1,115 @@
+{{#ifEquals modules.database.engine "drift"}}
+import 'dart:io';
+
+import 'package:drift/drift.dart';
+import 'package:drift/native.dart';
+import 'package:path/path.dart' as p;
+import 'package:path_provider/path_provider.dart';
+
+part 'database_datasource.g.dart';
+
+@DriftDatabase(tables: [])
+class AppDatabase extends _$AppDatabase {
+  AppDatabase() : super(_openConnection());
+
+  @override
+  int get schemaVersion => 1;
+
+  @override
+  MigrationStrategy get migration => MigrationStrategy(
+        onCreate: (m) async {
+          await m.createAll();
+        },
+        onUpgrade: (m, from, to) async {
+          // Add migration steps here as the schema evolves.
+        },
+      );
+
+  static QueryExecutor _openConnection() {
+    return LazyDatabase(() async {
+      final dir = await getApplicationDocumentsDirectory();
+      final file = File(p.join(dir.path, '{{project.name}}.db'));
+      return NativeDatabase.createInBackground(file);
+    });
+  }
+
+  Future<void> clearAll() async {
+    // Delete all rows from each table.
+    // Add table.deleteAll() calls here for each table you define.
+  }
+}
+{{/ifEquals}}
+{{#ifEquals modules.database.engine "hive"}}
+import 'package:hive_ce_flutter/hive_flutter.dart';
+
+abstract class HiveDatabaseDataSource {
+  Future<void> initialize();
+  Future<void> close();
+  Future<void> clearAll();
+}
+
+class HiveDatabaseDataSourceImpl implements HiveDatabaseDataSource {
+  // Register adapters and open boxes here as you add domain models.
+  // Example:
+  //   Hive.registerAdapter(MyModelAdapter());
+  //   await Hive.openBox<MyModel>('myModels');
+
+  @override
+  Future<void> initialize() async {
+    await Hive.initFlutter();
+    // TODO: register adapters and open boxes
+  }
+
+  @override
+  Future<void> close() async {
+    await Hive.close();
+  }
+
+  @override
+  Future<void> clearAll() async {
+    // Delete all boxes to reset local state.
+    await Hive.deleteFromDisk();
+  }
+}
+{{/ifEquals}}
+{{#ifEquals modules.database.engine "isar"}}
+import 'package:isar/isar.dart';
+import 'package:path_provider/path_provider.dart';
+
+abstract class IsarDatabaseDataSource {
+  Future<void> initialize();
+  Future<void> close();
+  Future<void> clearAll();
+}
+
+class IsarDatabaseDataSourceImpl implements IsarDatabaseDataSource {
+  late Isar _isar;
+
+  Isar get isar => _isar;
+
+  // Add your collection schemas to the list below as you define them.
+  // Example: schemas: [MyModelSchema]
+  static const List<CollectionSchema<dynamic>> _schemas = [];
+
+  @override
+  Future<void> initialize() async {
+    final dir = await getApplicationDocumentsDirectory();
+    _isar = await Isar.open(
+      _schemas,
+      directory: dir.path,
+    );
+  }
+
+  @override
+  Future<void> close() async {
+    await _isar.close();
+  }
+
+  @override
+  Future<void> clearAll() async {
+    await _isar.writeTxn(() async {
+      await _isar.clear();
+    });
+  }
+}
+{{/ifEquals}}

package/templates/modules/database/lib/features/database/data/repositories/database_repository_impl.dart.hbs

@@ -0,0 +1,73 @@
+import '../../domain/repositories/database_repository.dart';
+{{#ifEquals modules.database.engine "drift"}}
+import '../datasources/database_datasource.dart';
+
+class DatabaseRepositoryImpl implements DatabaseRepository {
+  final AppDatabase _db;
+
+  const DatabaseRepositoryImpl(this._db);
+
+  @override
+  Future<void> initialize() async {
+    // Drift opens the database lazily on first query; no explicit init needed.
+  }
+
+  @override
+  Future<void> close() async {
+    await _db.close();
+  }
+
+  @override
+  Future<void> clearAll() async {
+    await _db.clearAll();
+  }
+}
+{{/ifEquals}}
+{{#ifEquals modules.database.engine "hive"}}
+import '../datasources/database_datasource.dart';
+
+class DatabaseRepositoryImpl implements DatabaseRepository {
+  final HiveDatabaseDataSource _dataSource;
+
+  const DatabaseRepositoryImpl(this._dataSource);
+
+  @override
+  Future<void> initialize() async {
+    await _dataSource.initialize();
+  }
+
+  @override
+  Future<void> close() async {
+    await _dataSource.close();
+  }
+
+  @override
+  Future<void> clearAll() async {
+    await _dataSource.clearAll();
+  }
+}
+{{/ifEquals}}
+{{#ifEquals modules.database.engine "isar"}}
+import '../datasources/database_datasource.dart';
+
+class DatabaseRepositoryImpl implements DatabaseRepository {
+  final IsarDatabaseDataSource _dataSource;
+
+  const DatabaseRepositoryImpl(this._dataSource);
+
+  @override
+  Future<void> initialize() async {
+    await _dataSource.initialize();
+  }
+
+  @override
+  Future<void> close() async {
+    await _dataSource.close();
+  }
+
+  @override
+  Future<void> clearAll() async {
+    await _dataSource.clearAll();
+  }
+}
+{{/ifEquals}}

package/templates/modules/database/lib/features/database/domain/repositories/database_repository.dart.hbs

@@ -0,0 +1,10 @@
+abstract class DatabaseRepository {
+  /// Initialize the database connection and run any pending migrations.
+  Future<void> initialize();
+
+  /// Close the database connection and release resources.
+  Future<void> close();
+
+  /// Delete all data from the database (useful for logout/reset flows).
+  Future<void> clearAll();
+}

package/templates/modules/database/lib/features/database/presentation/providers/database_provider.dart.hbs

@@ -0,0 +1,43 @@
+import 'package:flutter_riverpod/flutter_riverpod.dart';
+import 'package:riverpod_annotation/riverpod_annotation.dart';
+import '../../data/datasources/database_datasource.dart';
+import '../../data/repositories/database_repository_impl.dart';
+import '../../domain/repositories/database_repository.dart';
+
+part 'database_provider.g.dart';
+
+{{#ifEquals modules.database.engine "drift"}}
+@Riverpod(keepAlive: true)
+AppDatabase appDatabase(Ref ref) {
+  final db = AppDatabase();
+  ref.onDispose(db.close);
+  return db;
+}
+
+@Riverpod(keepAlive: true)
+DatabaseRepository databaseRepository(Ref ref) {
+  return DatabaseRepositoryImpl(ref.watch(appDatabaseProvider));
+}
+{{/ifEquals}}
+{{#ifEquals modules.database.engine "hive"}}
+@Riverpod(keepAlive: true)
+HiveDatabaseDataSource hiveDatabaseDataSource(Ref ref) {
+  return HiveDatabaseDataSourceImpl();
+}
+
+@Riverpod(keepAlive: true)
+DatabaseRepository databaseRepository(Ref ref) {
+  return DatabaseRepositoryImpl(ref.watch(hiveDatabaseDataSourceProvider));
+}
+{{/ifEquals}}
+{{#ifEquals modules.database.engine "isar"}}
+@Riverpod(keepAlive: true)
+IsarDatabaseDataSource isarDatabaseDataSource(Ref ref) {
+  return IsarDatabaseDataSourceImpl();
+}
+
+@Riverpod(keepAlive: true)
+DatabaseRepository databaseRepository(Ref ref) {
+  return DatabaseRepositoryImpl(ref.watch(isarDatabaseDataSourceProvider));
+}
+{{/ifEquals}}

package/templates/modules/database/pubspec.partial.yaml

@@ -0,0 +1,27 @@
+{{#ifEquals modules.database.engine "drift"}}
+dependencies:
+  drift: ^2.22.1
+  sqlite3_flutter_libs: ^0.5.28
+  path_provider: ^2.1.5
+  path: ^1.9.0
+dev_dependencies:
+  drift_dev: ^2.22.1
+  build_runner: ^2.4.13
+{{/ifEquals}}
+{{#ifEquals modules.database.engine "hive"}}
+dependencies:
+  hive_ce_flutter: ^2.8.0
+  path_provider: ^2.1.5
+dev_dependencies:
+  hive_ce_generator: ^1.8.3
+  build_runner: ^2.4.13
+{{/ifEquals}}
+{{#ifEquals modules.database.engine "isar"}}
+dependencies:
+  isar: ^3.1.0+1
+  isar_flutter_libs: ^3.1.0+1
+  path_provider: ^2.1.5
+dev_dependencies:
+  isar_generator: ^3.1.0+1
+  build_runner: ^2.4.13
+{{/ifEquals}}

package/templates/modules/deep-linking/lib/features/deep_linking/data/datasources/deep_link_datasource.dart.hbs

@@ -0,0 +1,18 @@
+import 'package:app_links/app_links.dart';
+
+abstract class DeepLinkDataSource {
+  Stream<Uri> get onDeepLink;
+  Future<Uri?> getInitialLink();
+}
+
+class AppLinksDataSource implements DeepLinkDataSource {
+  final AppLinks _appLinks;
+
+  AppLinksDataSource({AppLinks? appLinks}) : _appLinks = appLinks ?? AppLinks();
+
+  @override
+  Stream<Uri> get onDeepLink => _appLinks.uriLinkStream;
+
+  @override
+  Future<Uri?> getInitialLink() => _appLinks.getInitialLink();
+}

package/templates/modules/deep-linking/lib/features/deep_linking/data/repositories/deep_link_repository_impl.dart.hbs

@@ -0,0 +1,14 @@
+import '../../domain/repositories/deep_link_repository.dart';
+import '../datasources/deep_link_datasource.dart';
+
+class DeepLinkRepositoryImpl implements DeepLinkRepository {
+  final DeepLinkDataSource _dataSource;
+
+  DeepLinkRepositoryImpl(this._dataSource);
+
+  @override
+  Stream<Uri> get onDeepLink => _dataSource.onDeepLink;
+
+  @override
+  Future<Uri?> getInitialLink() => _dataSource.getInitialLink();
+}

package/templates/modules/deep-linking/lib/features/deep_linking/domain/repositories/deep_link_repository.dart.hbs

@@ -0,0 +1,7 @@
+abstract class DeepLinkRepository {
+  /// Stream of incoming deep link URIs.
+  Stream<Uri> get onDeepLink;
+
+  /// Get the initial deep link that launched the app, if any.
+  Future<Uri?> getInitialLink();
+}

package/templates/modules/deep-linking/lib/features/deep_linking/presentation/providers/deep_link_provider.dart.hbs

@@ -0,0 +1,57 @@
+import 'package:flutter_riverpod/flutter_riverpod.dart';
+import 'package:go_router/go_router.dart';
+import 'package:riverpod_annotation/riverpod_annotation.dart';
+import '../../data/datasources/deep_link_datasource.dart';
+import '../../data/repositories/deep_link_repository_impl.dart';
+import '../../domain/repositories/deep_link_repository.dart';
+
+part 'deep_link_provider.g.dart';
+
+@riverpod
+DeepLinkDataSource deepLinkDataSource(Ref ref) {
+  return AppLinksDataSource();
+}
+
+@riverpod
+DeepLinkRepository deepLinkRepository(Ref ref) {
+  return DeepLinkRepositoryImpl(ref.watch(deepLinkDataSourceProvider));
+}
+
+/// Handles incoming deep links by navigating with go_router.
+/// Call this provider in your app's root widget to activate deep link handling.
+@riverpod
+Stream<Uri> deepLinkStream(Ref ref) {
+  return ref.watch(deepLinkRepositoryProvider).onDeepLink;
+}
+
+/// Notifier that sets up deep link handling with go_router.
+@riverpod
+class DeepLinkHandler extends _$DeepLinkHandler {
+  @override
+  Future<void> build() async {
+    final repo = ref.watch(deepLinkRepositoryProvider);
+
+    // Handle the initial link that launched the app
+    final initialLink = await repo.getInitialLink();
+    if (initialLink != null) {
+      _navigate(initialLink);
+    }
+
+    // Listen for incoming links while app is running
+    final subscription = repo.onDeepLink.listen(_navigate);
+    ref.onDispose(subscription.cancel);
+  }
+
+  void _navigate(Uri uri) {
+    // The router will handle the navigation based on go_router config.
+    // Scheme: {{modules.deepLinking.scheme}}, Host: {{modules.deepLinking.host}}
+    final router = ref.read(routerProvider);
+    router.go(uri.path, extra: uri.queryParameters);
+  }
+}
+
+// Provide the router instance — override this in your app's provider scope.
+@riverpod
+GoRouter router(Ref ref) {
+  throw UnimplementedError('Override routerProvider with your GoRouter instance');
+}

package/templates/modules/deep-linking/pubspec.partial.yaml

@@ -0,0 +1,2 @@
+dependencies:
+  app_links: ^6.3.3

package/templates/modules/i18n/l10n.yaml.hbs

@@ -0,0 +1,5 @@
+arb-dir: lib/l10n
+template-arb-file: app_{{modules.i18n.defaultLocale}}.arb
+output-localization-file: app_localizations.dart
+output-class: AppLocalizations
+nullable-getter: false

package/templates/modules/i18n/lib/core/l10n/l10n_config.dart.hbs

@@ -0,0 +1,29 @@
+import 'package:flutter/material.dart';
+import 'package:flutter_localizations/flutter_localizations.dart';
+import 'package:flutter_gen/gen_l10n/app_localizations.dart';
+
+export 'package:flutter_gen/gen_l10n/app_localizations.dart';
+
+/// Localization configuration for the application.
+///
+/// Provides [localizationsDelegates] and [supportedLocales] to be passed
+/// to [MaterialApp] or [CupertinoApp].
+class L10nConfig {
+  const L10nConfig._();
+
+  /// Delegates required by [MaterialApp.localizationsDelegates].
+  static const List<LocalizationsDelegate<dynamic>> localizationsDelegates = [
+    AppLocalizations.delegate,
+    GlobalMaterialLocalizations.delegate,
+    GlobalWidgetsLocalizations.delegate,
+    GlobalCupertinoLocalizations.delegate,
+  ];
+
+  /// The list of locales supported by this application.
+  static const List<Locale> supportedLocales = AppLocalizations.supportedLocales;
+}
+
+/// Extension on [BuildContext] to conveniently access [AppLocalizations].
+extension L10nExtension on BuildContext {
+  AppLocalizations get l10n => AppLocalizations.of(this)!;
+}

package/templates/modules/i18n/lib/core/l10n/l10n_provider.dart.hbs

@@ -0,0 +1,20 @@
+import 'package:flutter/material.dart';
+import 'package:flutter_riverpod/flutter_riverpod.dart';
+import 'package:riverpod_annotation/riverpod_annotation.dart';
+
+part 'l10n_provider.g.dart';
+
+/// Notifier that manages the current [Locale] for the application.
+/// Use [localeProvider] to watch the locale and [LocaleNotifier.setLocale]
+/// to change it at runtime.
+@riverpod
+class LocaleNotifier extends _$LocaleNotifier {
+  @override
+  Locale build() => const Locale('{{modules.i18n.defaultLocale}}');
+
+  /// Sets the active locale.
+  void setLocale(Locale locale) => state = locale;
+
+  /// Resets to the default locale.
+  void resetToDefault() => state = const Locale('{{modules.i18n.defaultLocale}}');
+}

package/templates/modules/i18n/lib/l10n/app_de.arb.hbs

@@ -0,0 +1,27 @@
+{
+  "@@locale": "de",
+  "appTitle": "{{project.name}}",
+  "@appTitle": {
+    "description": "Der Titel der Anwendung"
+  },
+  "welcomeMessage": "Willkommen bei {{project.name}}",
+  "@welcomeMessage": {
+    "description": "Willkommensnachricht auf dem Startbildschirm"
+  },
+  "errorGeneric": "Etwas ist schiefgelaufen. Bitte versuche es erneut.",
+  "@errorGeneric": {
+    "description": "Allgemeine Fehlermeldung"
+  },
+  "retry": "Wiederholen",
+  "@retry": {
+    "description": "Beschriftung für den Wiederholen-Button"
+  },
+  "cancel": "Abbrechen",
+  "@cancel": {
+    "description": "Beschriftung für den Abbrechen-Button"
+  },
+  "ok": "OK",
+  "@ok": {
+    "description": "Beschriftung für den OK-Button"
+  }
+}

package/templates/modules/i18n/lib/l10n/app_en.arb.hbs

@@ -0,0 +1,27 @@
+{
+  "@@locale": "en",
+  "appTitle": "{{project.name}}",
+  "@appTitle": {
+    "description": "The title of the application"
+  },
+  "welcomeMessage": "Welcome to {{project.name}}",
+  "@welcomeMessage": {
+    "description": "Welcome message shown on the home screen"
+  },
+  "errorGeneric": "Something went wrong. Please try again.",
+  "@errorGeneric": {
+    "description": "Generic error message"
+  },
+  "retry": "Retry",
+  "@retry": {
+    "description": "Label for retry button"
+  },
+  "cancel": "Cancel",
+  "@cancel": {
+    "description": "Label for cancel button"
+  },
+  "ok": "OK",
+  "@ok": {
+    "description": "Label for OK button"
+  }
+}