How johnong55/reminote works
Project type and purpose
• REMINOTE is a cross-platform (Android, iOS, Web, Windows, macOS, Linux) Flutter application for note-taking and reminders.
• It supports offline-first functionality (using Isar local DB) with automatic sync to Firebase (Auth & Realtime/Firestore).
High-level file-structure analysis
• Platform directories (android/, ios/, web/, linux/, macos/, windows/) contain native wrappers & build scripts.
• lib/ is the heart of the app:
• lib/Page: UI screens and navigation
• lib/components: reusable widgets & dialogs
• lib/providers: state-management classes (Provider pattern)
• lib/services: business logic, orchestration (AuthService, NoteService, sync_service, etc.)
• lib/Offline_Repository & lib/Online_Repository: data access layers (Repository pattern)
• lib/API/firebase_api.dart: low-level Firebase calls
• lib/models: data models for offline (Isar) and online (Firebase)
• lib/utils & lib/config: helpers, constants, theming
a. Presentation Layer
• Screens & Widgets (lib/Page + lib/components)
• State-management (lib/providers)
b. Domain/Service Layer
• Services (AuthService, NoteService, HabitService, SyncService, etc.)
c. Data Layer
• Repositories:
• Offline (Isar)
• Online (Firebase)
• Low-level API (firebase_api.dart)
d. Data Stores & External Services
• Local DB: Isar
• Remote: Firebase Authentication, Firebase Realtime/Firestore
e. Platform Hosts
• Flutter engine on each platform (Android/iOS/Web/etc.)
Component relationships & interactions
• UI widgets dispatch user actions → Providers
• Providers call Services to perform business operations
• Services delegate to Repositories
• Offline Repository reads/writes local DB
• Online Repository performs Firebase calls via firebase_api
• SyncService monitors network & syncs local changes to Firebase
• Repositories return model objects back up to Services → Providers → UI
Important architectural patterns & principles
• Layered architecture separating Presentation, Domain, Data
• Repository pattern for data-source abstraction (Offline vs Online)
• Provider pattern for state management in Flutter
• Offline-first sync strategy (SyncService)
Technologies & frameworks
• Flutter & Dart
• Provider (state management)
• Isar (local persistence)
• Firebase (Auth, Realtime DB / Firestore)
• Lottie (animations)
Essential elements checklist
• Clear, self-descriptive labels on every component
• A note on the SyncService’s role in offline/online reconciliation