Skip to content

.agent.md

Latest commit

 

History

History
56 lines (48 loc) · 2.28 KB

.agent.md

File metadata and controls

56 lines (48 loc) · 2.28 KB
Raw

AI Agent Context: iBuddhism

This document provides context for AI assistants working on the iBuddhism codebase.

Project Identity

Name: iBuddhism Description: A minimalist Flutter companion app for practitioners of Nichiren Daishonin Buddhism. License: GNU General Public License v3.0.

Tech Stack

  • Framework: Flutter (Dart)
  • UI Library: Material 3
  • Specific UI Libs: liquid_glass_renderer (for bottom nav and playback controls).
  • Local Storage: shared_preferences (settings), path_provider (file system access).
  • Media: image_picker (avatar selection).
  • Internationalization: flutter_localizations, intl, ARB files (located in lib/l10n/).

Core Features

  1. Gongyo Recitation:
    • Rhythmic reading interface.
    • Dual text display: Japanese romanization + Original Chinese.
    • Chapter selection: Hoben-pon, Juryo-hon.
  2. Library:
    • Offline resources (primarily Portuguese content).
  3. Progress & Goals:
    • Calendar view for tracking recitation consistency.
    • Monthly and weekly goal setting.
  4. User Profile:
    • Customizable name, bio, and avatar (photo or generated color).
  5. Theming:
    • Light / Dark / Auto modes.
    • Liquid glass aesthetic for navigation.

Development Environment

  • SDK: Flutter Stable.
  • Platforms: iOS (Xcode required), Android (Android Studio required).
  • Configuration:
    • iOS Permissions: NSCameraUsageDescription, NSPhotoLibraryUsageDescription in Info.plist.
    • Localization: Configured via l10n.yaml.

Common Commands

  • Run App: flutter run
  • Run Tests: flutter test
  • Generate Localization: flutter gen-l10n
  • Generate App Icons: dart run flutter_launcher_icons
  • Build iOS: flutter build ios
  • Build Android: flutter build apk or flutter build appbundle

Coding Conventions

  • i18n: All user-facing strings must be extracted to ARB files. Do not hardcode strings in widgets.
  • UI: Adhere to Material 3 guidelines where possible, blending with the custom "Liquid Glass" style.
  • State Management: [To be defined - currently inferred as standard Flutter state or unspecified]

Architecture Overview

  • Data: Local-first architecture using device storage.
  • Presentation: Flutter Widgets.