Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Cristiang1021/ErgoKawsay/llms.txt

Use this file to discover all available pages before exploring further.

ErgoKawsay targets Android (API 21+) as its primary platform. The repository also contains macOS, Linux, Windows, Web, and iOS runners, though notifications are Android-only at this time. The app is entirely offline — there are no environment variables, secrets, or backend services to configure before building.

​
Requirements

Flutter ≥ 3.2.0

Install from flutter.dev. Dart 3.2.0 is included with Flutter — no separate Dart installation needed.

Android SDK — API 21+

Minimum SDK version is Android 5.0 (API 21). Install via Android Studio or the standalone SDK tools. A physical device or emulator is required to run the app.

VS Code or Android Studio

Both editors have first-class Flutter support. Install the Flutter and Dart extensions (VS Code) or the Flutter plugin (Android Studio).

Dart ≥ 3.2.0

The SDK constraint in pubspec.yaml is >=3.2.0 <4.0.0. The Flutter SDK ships the matching Dart version automatically.

​
Verify Environment

Run Flutter’s built-in doctor to confirm your toolchain is ready: 
flutter doctor
Resolve any issues flagged under the Android toolchain and Connected device sections before proceeding.

​
Get Dependencies

flutter pub get
This fetches all packages declared in pubspec.yaml, including shared_preferences, flutter_local_notifications, timezone, just_audio, video_player, google_fonts, and provider.

​
Debug Build

Run on a connected Android device or emulator with hot reload enabled: 
flutter run                    # auto-detects connected device
flutter run -d android         # explicitly target Android
To list available devices and emulators: 
flutter devices
flutter emulators --launch <emulator_id>

​
Release APK

Build a signed release APK suitable for sideloading or distribution outside the Play Store: 
flutter build apk --release
Output: build/app/outputs/flutter-apk/app-release.apk The release build applies R8 code shrinking and resource optimization automatically. No additional ProGuard configuration is required for the packages used.

​
Play Store App Bundle

Build an Android App Bundle (AAB) for submission to Google Play: 
flutter build appbundle --release
Output: build/app/outputs/bundle/release/app-release.aab Google Play uses the AAB to generate optimized APKs per device architecture and screen density, reducing install size for end users.

​
Static Analysis

Run Flutter’s static analyzer to check for lint violations and type errors: 
flutter analyze
Lint rules are defined in analysis_options.yaml using the flutter_lints ^4.0.0 rule set (declared in dev_dependencies).

​
App Icon

Launcher icons are generated with flutter_launcher_icons ^0.14.3, configured in pubspec.yaml: 
flutter_launcher_icons:
  android: true
  ios: true
  image_path: "assets/illustrations/splash_hero.png"
  min_sdk_android: 21
  adaptive_icon_background: "#FFFFFF"
  adaptive_icon_foreground: "assets/illustrations/splash_hero.png"
After changing the source image, regenerate all icon sizes: 
dart run flutter_launcher_icons
This writes platform-specific icon files for all required resolutions into android/app/src/main/res/ and ios/Runner/Assets.xcassets/.

​
Platform Support

PlatformStatusNotes
Android (API 21+)✅ Primary targetFull feature support
iOS✅ Runner presentNotifications are Android-only
Web✅ Runner presentAudio/video may differ
macOS✅ Runner presentDesktop runner only
Linux✅ Runner presentDesktop runner only
Windows✅ Runner presentDesktop runner only
ErgoKawsay is a fully offline app. No environment variables, API keys, secrets, or backend configuration are required to build or run. After flutter pub get, the app is ready to build and run without any additional setup steps.

Build docs developers (and LLMs) love

Get started for freeTalk to us