Files
HouseHoldKeaper/.planning/phases/01-foundation/01-01-PLAN.md

13 KiB

phase, plan, type, wave, depends_on, files_modified, autonomous, requirements, must_haves
phase plan type wave depends_on files_modified autonomous requirements must_haves
01-foundation 01 execute 1
pubspec.yaml
analysis_options.yaml
build.yaml
l10n.yaml
lib/main.dart
lib/core/database/database.dart
lib/core/providers/database_provider.dart
lib/core/theme/app_theme.dart
lib/core/theme/theme_provider.dart
lib/l10n/app_de.arb
true
FOUND-01
FOUND-02
FOUND-03
THEME-01
THEME-02
truths artifacts key_links
Drift database opens on first launch with schemaVersion 1
drift_dev make-migrations runs without errors and captures schema v1
Riverpod providers generate via build_runner without errors
riverpod_lint is active and dart analyze reports no issues
ARB localization file exists with all German strings for Phase 1
Light and dark ColorScheme definitions use sage green seed with warm surface overrides
ThemeMode provider defaults to system and supports light/dark/system switching
path provides contains
pubspec.yaml All dependencies (flutter_riverpod, drift, go_router, etc.) flutter_riverpod
path provides contains
analysis_options.yaml riverpod_lint plugin configuration riverpod_lint
path provides contains
build.yaml Drift code generation configuration drift_dev
path provides contains
l10n.yaml ARB localization configuration app_de.arb
path provides contains
lib/core/database/database.dart AppDatabase class with schemaVersion 1 schemaVersion => 1
path provides contains
lib/core/providers/database_provider.dart Riverpod provider for AppDatabase @riverpod
path provides contains
lib/core/theme/app_theme.dart Light and dark ColorScheme with sage & stone palette ColorScheme.fromSeed
path provides contains
lib/core/theme/theme_provider.dart ThemeNotifier with shared_preferences persistence @riverpod
path provides contains
lib/l10n/app_de.arb German localization strings tabHome
from to via pattern
lib/core/theme/theme_provider.dart shared_preferences SharedPreferences for theme persistence SharedPreferences
from to via pattern
lib/core/database/database.dart drift_flutter driftDatabase() for SQLite connection driftDatabase
from to via pattern
lib/core/providers/database_provider.dart lib/core/database/database.dart Riverpod provider exposes AppDatabase AppDatabase
Scaffold the Flutter project and build all core infrastructure: Drift database with migration workflow, Riverpod providers with code generation, theme definitions (sage & stone palette), and ARB localization strings.

Purpose: Establish every foundational dependency and pattern so Plan 02 can build the UI shell without any infrastructure work. Output: A Flutter project that compiles, has all dependencies resolved, code generation working, database initialized, and theme/localization ready for consumption by UI code.

<execution_context> @/home/jlmak/.claude/get-shit-done/workflows/execute-plan.md @/home/jlmak/.claude/get-shit-done/templates/summary.md </execution_context>

@.planning/PROJECT.md @.planning/ROADMAP.md @.planning/STATE.md @.planning/phases/01-foundation/1-CONTEXT.md @.planning/phases/01-foundation/01-RESEARCH.md Task 1: Create Flutter project and configure all dependencies and tooling pubspec.yaml, analysis_options.yaml, build.yaml, l10n.yaml 1. Run `flutter create household_keeper --org com.jlmak --platforms android` inside the project root (the project root IS the repo root `/home/jlmak/Projects/jlmak/HouseHoldKeaper`). Since the repo already has files (LICENSE, README.md, .gitignore, .planning/), use `--project-name household_keeper` and target the current directory: `flutter create . --org com.jlmak --platforms android --project-name household_keeper`. This avoids creating a subdirectory.
  1. Add runtime dependencies: flutter pub add flutter_riverpod riverpod_annotation drift drift_flutter go_router path_provider shared_preferences

  2. Add dev dependencies: flutter pub add -d riverpod_generator drift_dev build_runner riverpod_lint

  3. Add flutter_localizations and intl manually to pubspec.yaml since they use the SDK dependency format:

    dependencies:
      flutter_localizations:
        sdk: flutter
      intl: any
    
  4. Add generate: true under the flutter: section in pubspec.yaml.

  5. Create l10n.yaml in project root:

    arb-dir: lib/l10n
    template-arb-file: app_de.arb
    output-localization-file: app_localizations.dart
    nullable-getter: false
    
  6. Update analysis_options.yaml to include riverpod_lint:

    include: package:flutter_lints/flutter.yaml
    
    plugins:
      riverpod_lint: ^3.1.3
    
  7. Create build.yaml in project root for Drift configuration:

    targets:
      $default:
        builders:
          drift_dev:
            options:
              databases:
                household_keeper: lib/core/database/database.dart
              sql:
                dialect: sqlite
                options:
                  version: "3.38"
    
  8. Run flutter pub get to verify all dependencies resolve cleanly. cd /home/jlmak/Projects/jlmak/HouseHoldKeaper && flutter pub get && echo "PASS: All dependencies resolved" Flutter project exists with all dependencies in pubspec.yaml (flutter_riverpod, drift, drift_flutter, go_router, path_provider, shared_preferences, flutter_localizations, intl, riverpod_annotation as runtime; riverpod_generator, drift_dev, build_runner, riverpod_lint as dev). l10n.yaml, build.yaml, and analysis_options.yaml configured correctly. flutter pub get succeeds.

Task 2: Create core infrastructure — database, providers, theme, and localization strings lib/core/database/database.dart, lib/core/providers/database_provider.dart, lib/core/theme/app_theme.dart, lib/core/theme/theme_provider.dart, lib/l10n/app_de.arb 1. Create `lib/core/database/database.dart` — the Drift database class: - Import `package:drift/drift.dart` and `package:drift_flutter/drift_flutter.dart` - Add `part 'database.g.dart';` - Define `@DriftDatabase(tables: [])` with empty tables list (tables added in Phase 2) - Class `AppDatabase extends _$AppDatabase` - Constructor accepts optional `QueryExecutor` for testing, defaults to `_openConnection()` - `@override int get schemaVersion => 1;` - Static `_openConnection()` returns `driftDatabase(name: 'household_keeper', native: const DriftNativeOptions(databaseDirectory: getApplicationSupportDirectory))` - Import `package:path_provider/path_provider.dart` for `getApplicationSupportDirectory`
  1. Create lib/core/providers/database_provider.dart — Riverpod provider for database:

    • Import riverpod_annotation and the database
    • Add part 'database_provider.g.dart';
    • Use @Riverpod(keepAlive: true) annotation (database must persist)
    • Function appDatabase(Ref ref) returns AppDatabase()
    • The provider creates the singleton database instance
  2. Create lib/core/theme/app_theme.dart — light and dark theme definitions:

    • Define AppTheme class with static methods lightTheme() and darkTheme() returning ThemeData
    • Light ColorScheme: ColorScheme.fromSeed(seedColor: Color(0xFF7A9A6D), brightness: Brightness.light, dynamicSchemeVariant: DynamicSchemeVariant.tonalSpot).copyWith(surface: Color(0xFFF5F0E8), surfaceContainerLowest: Color(0xFFFAF7F2), surfaceContainerLow: Color(0xFFF2EDE4), surfaceContainer: Color(0xFFEDE7DC), surfaceContainerHigh: Color(0xFFE7E0D5), surfaceContainerHighest: Color(0xFFE0D9CE))
    • Dark ColorScheme: Same seed, Brightness.dark, .copyWith(surface: Color(0xFF2A2520), surfaceContainerLowest: Color(0xFF1E1A16), surfaceContainerLow: Color(0xFF322D27), surfaceContainer: Color(0xFF3A342E), surfaceContainerHigh: Color(0xFF433D36), surfaceContainerHighest: Color(0xFF4D463F))
    • Both ThemeData set useMaterial3: true and use the respective ColorScheme
  3. Create lib/core/theme/theme_provider.dart — Riverpod provider for theme mode:

    • Import riverpod_annotation, flutter/material.dart, shared_preferences
    • Add part 'theme_provider.g.dart';
    • @riverpod class ThemeNotifier extends _$ThemeNotifier
    • build() method: read from SharedPreferences key 'theme_mode', parse to ThemeMode enum, default to ThemeMode.system
    • setThemeMode(ThemeMode mode) method: update state, persist to SharedPreferences
    • Use ref.read pattern for async SharedPreferences access (NOT ref.watch — this is a Notifier, not build())
    • Helper: _themeModeFromString(String? value) and _themeModeToString(ThemeMode mode) for serialization
  4. Create lib/l10n/app_de.arb — German localization strings for all Phase 1 UI:

    {
      "@@locale": "de",
      "appTitle": "HouseHoldKeaper",
      "tabHome": "Ubersicht",
      "tabRooms": "Raume",
      "tabSettings": "Einstellungen",
      "homeEmptyTitle": "Noch nichts zu tun!",
      "homeEmptyMessage": "Lege zuerst einen Raum an, um Aufgaben zu planen.",
      "homeEmptyAction": "Raum erstellen",
      "roomsEmptyTitle": "Hier ist noch alles leer!",
      "roomsEmptyMessage": "Erstelle deinen ersten Raum, um loszulegen.",
      "roomsEmptyAction": "Raum erstellen",
      "settingsSectionAppearance": "Darstellung",
      "settingsThemeLabel": "Farbschema",
      "themeSystem": "System",
      "themeLight": "Hell",
      "themeDark": "Dunkel",
      "settingsSectionAbout": "Uber",
      "aboutAppName": "HouseHoldKeaper",
      "aboutTagline": "Dein Haushalt, entspannt organisiert.",
      "aboutVersion": "Version {version}",
      "@aboutVersion": {
        "placeholders": {
          "version": { "type": "String" }
        }
      }
    }
    

    Note: Use proper German characters (umlauts) where appropriate. The tab labels "Ubersicht" should be "Ubersicht" and "Raume" should be "Raume" — but check CONTEXT.md which shows them without umlauts. Use umlauts in the ARB file: "Ubersicht", "Raume", "Uber" should actually be with umlauts if the font supports it. Per the CONTEXT.md the user specified "Ubersicht", "Raume", "Einstellungen" — follow exactly as specified there.

  5. Remove the default lib/main.dart content and replace with a minimal placeholder that imports ProviderScope (just enough to verify compilation — full wiring happens in Plan 02):

    import 'package:flutter/material.dart';
    import 'package:flutter_riverpod/flutter_riverpod.dart';
    
    void main() {
      runApp(const ProviderScope(child: MaterialApp(home: Scaffold())));
    }
    
  6. Run code generation: dart run build_runner build --delete-conflicting-outputs This generates: database.g.dart, database_provider.g.dart, theme_provider.g.dart

  7. Run Drift migration capture: dart run drift_dev make-migrations This captures schema version 1 in drift_schemas/ directory.

  8. Run dart analyze to verify riverpod_lint is active and no analysis issues exist. cd /home/jlmak/Projects/jlmak/HouseHoldKeaper && dart run build_runner build --delete-conflicting-outputs 2>&1 | tail -5 && dart analyze 2>&1 | tail -5 && echo "PASS: Codegen and analysis clean" database.dart defines AppDatabase with schemaVersion 1. database_provider.dart exposes AppDatabase via @riverpod. app_theme.dart provides lightTheme() and darkTheme() with sage green seed and warm surface overrides. theme_provider.dart provides ThemeNotifier with shared_preferences persistence and ThemeMode.system default. app_de.arb contains all German strings for Phase 1 screens. All .g.dart files generated successfully. drift_dev make-migrations has captured schema v1. dart analyze passes cleanly.

- `flutter pub get` succeeds (all dependencies resolve) - `dart run build_runner build` completes without errors (generates .g.dart files) - `dart run drift_dev make-migrations` completes (schema v1 captured) - `dart analyze` reports no errors (riverpod_lint active) - `flutter build apk --debug` compiles (project structure valid)

<success_criteria>

  • Flutter project scaffolded with all Phase 1 dependencies
  • Drift database class exists with schemaVersion 1 and migration workflow established
  • Riverpod providers created with @riverpod annotation and code generation
  • Light and dark theme definitions with sage & stone ColorScheme palette
  • ThemeMode provider with shared_preferences persistence
  • ARB localization file with all German strings for Phase 1
  • All code generation (.g.dart files) succeeds
  • dart analyze passes cleanly with riverpod_lint active </success_criteria>
After completion, create `.planning/phases/01-foundation/01-01-SUMMARY.md`