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.

This guide walks you through everything needed to get ErgoKawsay running on your local machine. By the end you will have the app launching on an Android emulator or physical device, ready for development or exploration. The entire setup takes about five minutes once Flutter is installed.

​
Prerequisites

Confirm the following tools are available before you begin:

Flutter SDK ≥ 3.2.0

The Flutter SDK is required to build and run the app. Version 3.2.0 or later is needed to satisfy the Dart SDK constraint (>=3.2.0 <4.0.0).

Dart ≥ 3.2.0

Dart 3.2.0 or later is required. Dart ships bundled with the Flutter SDK — no separate installation is needed.

Android SDK — API 21+

Android 5.0 (Lollipop) or higher is the minimum supported platform. Install via Android Studio or the standalone command-line tools.

Editor: VS Code or Android Studio

Either editor works well. Install the official Flutter extension (VS Code) or Flutter plugin (Android Studio) for hot reload, debugging, and device management.

​
Installation

1

Install Flutter and verify your environment

Download and install the Flutter SDK from the official installation guide, then verify everything is set up correctly:
flutter doctor
Resolve any issues flagged by flutter doctor — particularly the Android toolchain and connected-devices entries — before continuing.
2

Clone the repository

Clone the ErgoKawsay repository and move into the project directory:
git clone https://github.com/Cristiang1021/ErgoKawsay.git
cd ErgoKawsay
3

Install dependencies

Fetch all Dart and Flutter package dependencies declared in pubspec.yaml:
flutter pub get
This resolves packages such as provider, just_audio, video_player, flutter_local_notifications, and shared_preferences.
4

Run the app

List available devices, then launch the app on your chosen target:
flutter devices
flutter run
Flutter will prompt you to select a device if more than one is available, or will launch automatically if only one is connected.

​
Run on Android Emulator

If you prefer an emulator over a physical device, launch one first and then target Android explicitly: 
flutter emulators --launch Medium_Phone_API_36.1
flutter run -d android
Replace Medium_Phone_API_36.1 with the name of any emulator listed by flutter emulators. ErgoKawsay targets portrait orientation only — the emulator will lock to portrait automatically.

​
Build a Release APK

To produce a release-signed APK for sideloading or distribution: 
flutter build apk --release
The compiled APK is written to: 
build/app/outputs/flutter-apk/app-release.apk

​
Play Store Bundle

For submission to the Google Play Store, build an Android App Bundle (.aab) instead: 
flutter build appbundle --release
The bundle is written to build/app/outputs/bundle/release/app-release.aab.

​
Static Analysis

Run the Flutter analyzer to catch type errors, lint warnings, and code-style issues before committing: 
flutter analyze
The project uses flutter_lints as its analysis rule set, configured in analysis_options.yaml.

​
Regenerating Translations (Optional)

Python 3 and pyyaml are only needed if you modify translations.yaml and need to regenerate the compiled Dart file. Regular development and building does not require Python.
pip install pyyaml
python tools/gen_translations.py
This regenerates lib/core/localization/tr.dart from the bilingual source strings in translations.yaml. Supported language codes are es (Spanish) and qu (Kichwa).

Build docs developers (and LLMs) love

Get started for freeTalk to us