How jillianyeow18/dormify_mobile-main-6 works
Main Components
• Mobile Frontend (Flutter UI): This corresponds to the majority of your code within the lib folder. It contains subdirectories for pages (auth_page, chat, home_page, tenant and landlord pages, etc.) and components (like custom widgets and UI elements).
• Domain & Business Logic: Under lib you have a clear separation with directories for domains and repositories (chat_repository, landlord_repository, tenant_repository, etc.). This layer encapsulates data models and business logic (domain objects like chat_message.domain, tenant.domain, etc.), which interact with the UI and services.
• Services: In the lib/services folder you see services such as auth_service, notificationService, and utilities for distance calculation and geocoordinates. These services abstract interactions with external systems (such as authentication and push notifications) and provide essential functionality.
• External Integrations: The project integrates Firebase (firebase.json, firebase_options.dart, and possibly cloudinary_service), implying external backend services for data storage, authentication, and possibly cloud media handling.
• Platform-Specific Mobile Code: The android and ios directories contain native configuration and platform-specific code (AndroidManifest.xml, build.gradle, AppDelegate.swift, storyboards). They serve as the bridge between Flutter and the underlying mobile OS.
Component Relationships and Interactions
• Platform code (android and ios directories) represents the hosting environment that executes the Flutter app. Show a boundary separating Flutter’s abstracted code (in lib) from native configuration and build systems.
Architectural Patterns & Technologies
• Use of the Repository Pattern: The separation between the repositories, domains, and UI indicates an effort to keep data access and business logic modular.
• Technologies: Mention Flutter as the framework for building the cross-platform mobile UI. Include Firebase as your backend/authentication service and note that platform-specific setup is handled separately in the android and ios directories.
– To the side or at the bottom, show external systems (Firebase, and potentially Cloudinary) that interact with the services.