diff --git a/README.md b/README.md index f15ebb9..06b9653 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,65 @@ -# HouseHoldKeaper +# Household Keeper +Your household, effortlessly organized. + +Household Keeper helps you organize and manage your household tasks. Create rooms, assign tasks, set recurring reminders, and keep your home running smoothly. + +## Features + +- **Room Management** — Create and organize rooms with drag-and-drop reordering +- **Task Templates** — Quickly add common household tasks or create your own +- **Recurring Scheduling** — Daily, weekly, monthly, or yearly task recurrence +- **Calendar View** — Day-by-day task overview with a floating "Today" button +- **Task History** — View past completions for each task +- **Task Sorting** — Sort by name, due date, or room with persistent preferences +- **Notifications** — Local reminders for due tasks +- **Light & Dark Theme** — Follows your system preference +- **Localization** — German and English + +## Screenshots + +

+ + + + +

+ +## Tech Stack + +- **Flutter** (SDK ^3.11.0) +- **Riverpod** — State management +- **Drift** — Local SQLite database +- **GoRouter** — Navigation +- **flutter_local_notifications** — Scheduled reminders + +## Getting Started + +```bash +# Clone the repo +git clone https://gitea.jeanlucmakiola.de/makiolaj/HouseHoldKeaper.git +cd HouseHoldKeaper + +# Install dependencies +flutter pub get + +# Generate code (drift, riverpod, l10n) +dart run build_runner build --delete-conflicting-outputs + +# Run the app +flutter run +``` + +## Building + +```bash +# Debug APK +flutter build apk --debug + +# Release APK (requires signing config) +flutter build apk --release +``` + +## License + +[MIT](LICENSE) — Jean-Luc Makiola, 2026