Home Harmony

A cross-platform Flutter application for families to manage rules, rewards, and consequences for children.

Features

• Multi-user support: Parents (admin) and children (restricted)
• Family rules management
• Rewards for chores and good behavior
• Consequence tracking with time-bound restrictions
• Assign consequences to children or to rules (with automatic inheritance of children from rules)
• RESTful API integration
• Material Design 3 UI
• Firebase Authentication & Firestore

Getting Started

1. Ensure you have Flutter 3.0+ installed.
2. Run flutter pub get to install dependencies.
3. Use flutter run to launch the app on your device or emulator.

Project Structure Overview

lib/
  ├── main.dart
  ├── models/
  ├── services/
  ├── views/
  ├── widgets/
  └── utils/
test/ - Automated tests

Customization Instructions

Update the app to fit your family's needs by editing rules, rewards, and consequences in the app UI. For advanced customization, modify models, services, and UI components in the lib/ directory.

• To customize consequence assignment logic, see docs/consequences.md, lib/widgets/consequence_form.dart, and lib/views/consequences_view.dart.
• To customize rules logic, see docs/rules.md and lib/widgets/rule_dialog.dart.
• To customize rewards/chores logic, see docs/rewards.md and lib/screens/home/rewards_screen.dart.

MVP Implementation Roadmap

See docs/mvp_checklist.md for the full MVP checklist and progress tracking.

Architecture Overview

flowchart TD
    A[Flutter App]
    B[Backend Server]
    C[Firebase]
    D[State Management]
    E[UI]
    A -->|RESTful API| B
    A -->|Firebase Auth| C
    A -->|Firestore| C
    A -->|Riverpod| D
    A -->|Material Design 3| E
    D -->|Reactive| E
    C -->|Rules, Rewards, Consequences| E

Loading

License

This project is licensed under the MIT License. See LICENSE for details.

Contribution Guidelines

Contributions are welcome! Please open issues or submit pull requests. See CONTRIBUTING.md for guidelines.

Contact Information

Project Maintainers: Eric N. Garcia ([email protected])

Acknowledgments

• Flutter
• Firebase (firebase_core, firebase_auth, cloud_firestore)
• Provider
• http
• mocktail, fake_cloud_firestore (for testing)
• Material Design 3

Changelog

See CHANGELOG.md for updates and release notes.

Star History