How cmput301-w25/project-superiorintelligence works
Main Components Identification
a. Android Client:
• UI Layer: Includes Activities (e.g., HomeActivity, LoginPageActivity, ProfileActivity, etc.) and Fragments (DeleteMoodFragment, PostStatusFragment, etc.).
• UI Supporting Components: Adapters for RecyclerViews/ListViews (such as CommentsAdapter, EventAdapter, NotificationAdapter, UserAdapter).
• Business Logic / Managers: Classes like EventManager, HomeManager, FollowManager, SearchUserManager.
b. Data/Storage Layer:
• Local Data Handling: Classes like Database, Photo-related classes (Photobase) indicate local data storage or file handling.
• Remote/Cloud Integration: Firebase components (Firebase configuration, google-services.json) to manage remote data storage, authentication, and notifications.
c. Testing Components:
• Instrumented Tests (located under androidTest) for UI/Integration testing.
• Unit Tests (located under test) for business logic and components.
d. Build & Configuration:
• Gradle Scripts & Properties: Indicating dependencies, build configuration, and setup instructions.
• Firebase and other configuration files: firebase.json and google-services.json.
Relationships and Interactions
• UI components interact with the business logic (manager classes) to retrieve and display data.
• The business logic interfaces with both local data storage mechanisms (via the Database or Photobase classes) and Firebase for cloud operations.
• Adapters mediate between raw data (such as lists of events, users, or notifications) and the UI components.
• Testing layers interact with almost all components to ensure functionality from the UI down to the business logic and data layers.
• Gradle build configuration connects the source layers and dependencies, ensuring proper compilation and packaging.
Architectural Patterns and Design Principles
• The project uses separation of concerns by dividing UI, business logic, and data layers.
• Activity/Fragment based UI design is typical for Android apps.
• There is a clear emphasis on modularity: each feature (comments, events, notifications, and profile management) is implemented across dedicated classes and packages.
• Firebase integration suggests reliance on external cloud services to handle aspects like authentication, real-time data, or notifications.
Relevant Technologies & Frameworks
• Android Framework (Activities, Fragments, Adapters, Resource files in res/)
• Kotlin (as seen in build scripts and file extensions)
• Firebase (configured via google-services.json and firebase.json)
• Gradle (configured with *.gradle.kts scripts, wrapper directory, and version files)
Elements
• Clear and concise labels for every component (e.g., “HomeActivity”, “EventManager”, “Firebase Cloud”).
• Annotations for external services (Firebase) and configuration/build management (Gradle scripts).
• Adding notes that indicate where testing components live and how they validate interactions between layers.