Go to file
LemonNexus bdf4213ea6 docs: Complete README and BUILD documentation
ADDED:
- README.md - Complete project documentation with:
  - Feature overview
  - Quick start guide
  - Project structure
  - Development instructions
  - Home Assistant integration guide
  - Contributing guidelines

- BUILD.md - Step-by-step APK build guide:
  - Prerequisites
  - Flutter installation (script + manual)
  - Build commands (debug + release)
  - Installation methods
  - Troubleshooting section
  - Multi-platform build instructions

REPOSITORY NOW CONTAINS:
 Complete Flutter app structure
 Data models (Routine, Activity, Gamification)
 UI screens (Dashboard, Routines, Calendar, Stats, Settings)
 Services (Database, Notifications)
 Home Assistant integration (6 sensors, 4 buttons)
 Build scripts and documentation

READY FOR APK BUILD:
Users can now follow BUILD.md to compile the app.
2026-02-14 12:56:27 +00:00
android feat: Complete LifeFlow implementation - Notifications, HA Integration, Scripts 2026-02-14 12:55:09 +00:00
docs feat: LifeFlow - Personal Life Management System - Initial Commit 2026-02-14 03:24:28 +00:00
home-assistant feat: Complete LifeFlow implementation - Notifications, HA Integration, Scripts 2026-02-14 12:55:09 +00:00
scripts feat: Complete LifeFlow implementation - Notifications, HA Integration, Scripts 2026-02-14 12:55:09 +00:00
.gitignore feat: Complete Flutter app structure for LifeFlow 2026-02-14 12:49:20 +00:00
BUILD.md docs: Complete README and BUILD documentation 2026-02-14 12:56:27 +00:00
README.md docs: Complete README and BUILD documentation 2026-02-14 12:56:27 +00:00
analysis_options.yaml feat: Complete Flutter app structure for LifeFlow 2026-02-14 12:49:20 +00:00

README.md

🌊 LifeFlow - Personal Life Management System

Transform your daily routines into enjoyable habits

Flutter License

📱 Overview

LifeFlow is a comprehensive life management app that helps you track:

  • 💊 Medications & Vitamins
  • 📅 Appointments & Meetings
  • 😴 Sleep Schedule
  • 🍎 Food & Nutrition
  • 💧 Hydration
  • 🏃 Exercise
  • 🧼 Hygiene
  • 🧘 Self Care

Features

  • Easy Logging - One-tap routine completion
  • Smart Notifications - Never miss a routine
  • Gamification - Points, streaks, badges, levels
  • Home Assistant - Full integration with sensors & buttons
  • SMS Parsing - Auto-detect appointments from texts
  • Cross-Platform - Android, PC app, Web

🚀 Quick Start

Prerequisites

  • Flutter SDK 3.19 or higher
  • Android Studio (for Android SDK)
  • Git

Installation

  1. Clone the repository

    git clone https://git.lemonlink.eu/impulsivefps/LifeFlow.git
    cd LifeFlow
    
  2. Install Flutter (if not already installed)

    # Option 1: Use the provided script
    bash scripts/install_flutter.sh
    source ~/.bashrc
    
    # Option 2: Manual installation
    # Download from: https://docs.flutter.dev/get-started/install
    
  3. Navigate to Android app

    cd android
    
  4. Get dependencies

    flutter pub get
    
  5. Build APK

    # Debug APK (for testing)
    flutter build apk --debug
    
    # Release APK (for distribution)
    flutter build apk --release
    
  6. Find your APK

    build/app/outputs/flutter-apk/app-release.apk
    

📂 Project Structure

LifeFlow/
├── android/                    # Flutter Android App
│   ├── lib/
│   │   ├── main.dart          # App entry point
│   │   ├── models/            # Data models
│   │   │   ├── routine.dart   # Routine, Schedule, Reminder
│   │   │   ├── activity.dart  # Activity logging
│   │   │   └── gamification.dart # Points, badges, levels
│   │   ├── repositories/      # Data access layer
│   │   ├── screens/           # UI screens
│   │   │   ├── dashboard/     # Main dashboard
│   │   │   ├── routines/      # Routine management
│   │   │   ├── calendar/      # Calendar view
│   │   │   ├── stats/         # Statistics & progress
│   │   │   └── settings/      # App settings
│   │   ├── services/          # Business logic
│   │   │   ├── database_service.dart      # Hive database
│   │   │   └── notification_service.dart  # Local notifications
│   │   └── theme/             # App theming
│   └── pubspec.yaml           # Dependencies
│
├── home-assistant/             # Home Assistant Integration
│   └── custom_components/
│       └── lifeflow/
│           ├── __init__.py
│           ├── sensor.py      # 6 sensors
│           ├── button.py      # 4 buttons
│           ├── config_flow.py
│           └── manifest.json
│
├── scripts/                    # Build scripts
│   └── install_flutter.sh     # Flutter SDK installer
│
└── docs/                       # Documentation
    └── DEVELOPMENT_PLAN.md

🛠️ Development

Running in Debug Mode

cd android
flutter run

Running Tests

flutter test

Building for Different Platforms

# Android APK
flutter build apk --release

# Android App Bundle (for Play Store)
flutter build appbundle --release

# Windows
flutter build windows --release

# Linux
flutter build linux --release

# macOS
flutter build macos --release

🏠 Home Assistant Integration

Installation

  1. Copy the home-assistant/custom_components/lifeflow folder to your Home Assistant config/custom_components/ directory
  2. Restart Home Assistant
  3. Go to Settings > Devices & Services > Add Integration
  4. Search for "LifeFlow"

Available Entities

Sensors:

  • sensor.lifeflow_medications_today - Medications taken today
  • sensor.lifeflow_water_intake - Water consumed (mL)
  • sensor.lifeflow_sleep_quality - Sleep quality (%)
  • sensor.lifeflow_daily_progress - Daily completion (%)
  • sensor.lifeflow_current_streak - Current streak (days)
  • sensor.lifeflow_total_points - Total points

Buttons:

  • button.lifeflow_log_vitamins - Log vitamins
  • button.lifeflow_log_water - Log water
  • button.lifeflow_log_medication - Log medication
  • button.lifeflow_complete_routine - Complete routine

Example Automation

automation:
  - alias: "Morning Routine Complete"
    trigger:
      - platform: numeric_state
        entity_id: sensor.lifeflow_daily_progress
        above: 50
    condition:
      - condition: time
        after: "06:00:00"
        before: "09:00:00"
    action:
      - service: light.turn_on
        target:
          entity_id: light.bedroom
        data:
          brightness_pct: 100

📋 Feature Checklist

  • Flutter app structure
  • Data models (Routine, Activity, Gamification)
  • Repository layer with Riverpod
  • Dashboard UI with progress ring
  • Routine cards with categories
  • Light/Dark theme support
  • Local notifications service
  • Hive database setup
  • Home Assistant integration
  • SMS parsing implementation
  • PC app (Flutter Desktop)
  • Cloud sync
  • AI suggestions

🤝 Contributing

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/amazing-feature
  3. Commit your changes: git commit -m 'Add amazing feature'
  4. Push to the branch: git push origin feature/amazing-feature
  5. Open a Pull Request

📄 License

This project is licensed under the MIT License.


🙏 Acknowledgments

  • Flutter Team for the amazing framework
  • Home Assistant Community for the integration platform

Ready to transform your daily routines? Let's flow! 🌊