dotenv setup

Author: aguskoll

.gitignore

@@ -121,8 +121,6 @@ app.*.symbols
 !**/ios/**/default.perspectivev3
 !/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages
 !/dev/ci/**/Gemfile.lock
-/app/env/
-
 
 /modules/common/.flutter-plugins
 /modules/common/.flutter-plugins-dependencies

app/.gitignore

@@ -125,9 +125,8 @@ app.*.symbols
 /env*.json
 
 # Environment and configuration files (contain sensitive data)
-env/.env
-env/.settings
-env/env_*.json
+../env/.env
+../env/env_*.json
 .env
 .env.*
 *.env

app/env/.env.example

@@ -0,0 +1,15 @@
+#    The .env file MUST be in .gitignore
+#
+#   Each flavor (dev/qa/prod) uses the same .env file but reads
+#    different variables based on the suffix:
+#    - Development (main_dev.dart)  → reads *_DEV variables
+#    - QA/Staging (main_qa.dart)    → reads *_QA variables
+#    - Production (main.dart)       → reads *_PROD variables
+#
+#    Access variables in domain/lib/env/env_config.dart:
+#    static String get apiUrl => dotenv.env['API_URL_$env']?.toString() ?? '';
+
+API_URL_DEV=https://your-api-url-dev.com
+API_URL_QA=https://your-api-url-qa.com
+API_URL_PROD=https://your-api-url-prod.com
+

app/env/.settings.example

@@ -46,4 +46,22 @@ class FlavorConfig {
   static bool isDevelopment() => instance.flavor == Flavor.dev;
 
   static bool isQA() => instance.flavor == Flavor.qa;
+
+  /// Returns the environment file path (single .env file for all flavors)
+  ///
+  /// SETUP INSTRUCTIONS:
+  /// 1. Navigate to app/env/ directory
+  /// 2. Create a .env file (must be in .gitignore):
+  ///    cp .env.example .env
+  /// 3. Add your environment variables with flavor suffixes:
+  ///    API_URL_DEV=https://dev-api.example.com
+  ///    API_URL_QA=https://qa-api.example.com
+  ///    API_URL_PROD=https://api.example.com
+  /// 4. The active flavor determines which suffix is used (_DEV, _QA, _PROD)
+  /// 5. Access variables in domain/lib/env/env_config.dart using:
+  ///    static String get apiUrl => dotenv.env['API_URL_$env']?.toString() ?? '';
+  ///    (The $env automatically appends DEV, QA, or PROD based on active flavor)
+  static String getEnvFilePath() {
+    return 'env/.env.example';
+  }
 }

app/lib/main/env/env_config.dart

@@ -1,5 +1,6 @@
 import 'package:app/main/app.dart';
 import 'package:common/init.dart';
+import 'package:data/init.dart';
 import 'package:domain/init.dart';
 import 'package:example_domain/init.dart';
 import 'package:example_data/init.dart';
@@ -8,6 +9,8 @@ import 'package:flutter_dotenv/flutter_dotenv.dart';
 import 'package:get_it/get_it.dart';
 import 'package:url_strategy/url_strategy.dart';
 
+import 'env/env_config.dart';
+
 void init() async {
   WidgetsFlutterBinding.ensureInitialized();
   await initialize();
@@ -18,10 +21,12 @@ void init() async {
 final getIt = GetIt.instance;
 
 Future<void> initialize() async {
+  await dotenv.load(fileName: FlavorConfig.getEnvFilePath());
   await CommonInit.initialize(getIt);
-  await DomainInit.initialize(getIt);
   await DataInit.initialize(getIt);
+  await DomainInit.initialize(getIt);
+
   // Example Module init
-  await ExampleDomainInit.initialize(getIt);
   await ExampleDataInit.initialize(getIt);
+  await ExampleDomainInit.initialize(getIt);
 }

app/lib/main/init.dart

@@ -46,6 +46,8 @@ dependencies:
     path: ../modules/domain
   common:
     path: ../modules/common
+  data:
+    path: ../modules/data
 
   # Remove example dependencies
   example_data:
@@ -81,6 +83,8 @@ flutter:
   # Remove example assets.
   assets:
     - assets/images/
+    # remove example suffix
+    - env/.env.example
   fonts:
     - family: Roboto Black
       fonts:

app/pubspec.yaml

@@ -7,7 +7,7 @@ class EnvConfig {
 
   static String env = kDevEnv;
 
-  static String get envConfigFile => 'env/.settings.example';
+  static String get envConfigFile => 'env/.env.example';
 
   static String get apiUrl => dotenv.env['API_URL_$env']?.toString() ?? '';
 }

modules/domain/lib/env/env_config.dart

@@ -1,14 +1,10 @@
 import 'package:domain/bloc/app/app_cubit.dart';
 import 'package:domain/bloc/auth/auth_cubit.dart';
 import 'package:domain/services/auth_service.dart';
-import 'package:flutter_dotenv/flutter_dotenv.dart';
 import 'package:get_it/get_it.dart';
 
-import 'env/env_config.dart';
-
 class DomainInit {
   static Future<void> initialize(GetIt getIt) async {
-    await dotenv.load(fileName: EnvConfig.envConfigFile);
     //Cubits
     getIt.registerSingleton(AppCubit(getIt()));
     getIt.registerSingleton(AuthCubit());