Skip to content

Commit c56b6b1

Browse files
committed
docs: improve app environment descriptions
- Added descriptions to each environment - Clarified usage of each environment
1 parent f7d036c commit c56b6b1

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

lib/app/config/app_environment.dart

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,23 @@
1+
/// Defines the different application environments.
12
enum AppEnvironment {
3+
/// Represents the production environment.
4+
///
5+
/// This environment is used for the live application, connecting to
6+
/// production backend services and configurations.
27
production,
3-
developmentInMemory,
4-
developmentApi, // New: For local Dart Frog API
8+
9+
/// Represents a demonstration environment with in-memory data.
10+
///
11+
/// This environment is designed for showcasing the application's user
12+
/// interface and features without requiring any external backend services.
13+
/// All data operations are handled by mock data stored directly in memory,
14+
/// eliminating the need for API access.
15+
demo,
16+
17+
/// Represents a development environment connecting to a local API.
18+
///
19+
/// This environment is used during local development, typically connecting
20+
/// to a locally running Dart Frog backend API.
21+
development,
522
// Add other environments like staging, etc. as needed
623
}

0 commit comments

Comments
 (0)