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 (alli kawsay — “living well”) is a mobile application built for teachers who spend long hours standing, writing on blackboards, and working at computers. It delivers ergonomics education, guided exercise sessions, emotional health support, ambient audio, and smart reminders — all entirely offline, in both Spanish and Kichwa.

Quick Start

Install Flutter, clone the repo, and run ErgoKawsay on a device or emulator in minutes.

Architecture

Understand the feature-based project structure, state management, and data flow.

Core Modules

Explore the ergonomics, diseases, active breaks, and exercise modules.

Developer Guide

Deep-dive into services, localization, theming, and the build pipeline.

What ErgoKawsay Offers

ErgoKawsay is organized around three pillars of teacher well-being:

Body

Ergonomics education, musculoskeletal disease reference, guided active breaks, and an 8-category exercise library.

Mind

Emotional health with five named characters, preventive tips, ambient music, and educational videos.

Habits

Smart reminders for active breaks and daily exercise, progress tracking, and a teacher profile.

Get Started

1

Set up Flutter

Install Flutter SDK ≥ 3.2.0 and verify with flutter doctor. See the Quickstart for full instructions.
2

Clone and install dependencies

git clone https://github.com/Cristiang1021/ErgoKawsay.git
cd ErgoKawsay
flutter pub get
3

Run on a device or emulator

flutter run
The app launches with a language-selection splash screen. Choose Español or Kichwa to continue.
4

Build a release APK

flutter build apk --release
The APK is written to build/app/outputs/flutter-apk/app-release.apk.

Key Features

AreaHighlights
ErgonomicsStory-deck cards, posture illustrations, WHO statistics, knowledge quiz
DiseasesCarpal tunnel, tendinitis, lumbago, cervicalgia — causes, warnings, when to see a doctor
Active Breaks5-step guided sequence (neck → shoulders → wrists → lumbar → breathing) with timers
Exercises18 exercises across 8 body-zone categories with per-exercise session screens
Emotions5 characters (Inti, Yaku, RumiRumi, Tutam, Chaskym) with causes, coping strategies, affirmations
RemindersConfigurable break frequency (30 min–3 h), daily exercise alarm, night silence window
AccessibilityText scale slider, colorblind filter (deuteranopia matrix), light/dark theme
LanguagesFull bilingual UI — Spanish (es) and Kichwa (qu) from translations.yaml
ErgoKawsay is a fully offline app — there is no backend, no authentication, and no network calls at runtime. All data is stored locally with SharedPreferences.

Build docs developers (and LLMs) love