How cmput301-w25/project-vibecheck works
Project Type & Purpose
• The project is an Android mobile application (built using the Gradle Kotlin DSL) for “VibeCheck” – a mood/social app – which includes multiple screens such as Home, Login, SignUp, Profile, Mood Events, Mood History, and Comments.
• The README (even though brief) and the file structure confirm that this app’s core functionality is around mood events and user interactions, with separate screens (activities/fragments) dealing with login, history, comments, etc.
Analyzing the File Structure
• The top-level “code” directory holds the actual project source, and within it the “app” directory represents the Android module.
• The “src/main/java/com/example/vibecheck” directory contains packages grouped by feature: “ui/home”, “ui/login”, “ui/signup”, “ui/profile”, “ui/moodevents”, “ui/history”, and “ui/comments”. This shows a feature-based organization of code.
• Core utility classes exist (e.g., MoodUtils.java, NetworkStatusChecker.java) which likely support reusable logic and connectivity checks.
• The presence of “AndroidManifest.xml” and various XML layout files in “res” indicates the UI components are defined following Android standards.
• Multiple Gradle configuration files (build.gradle.kts, gradlew, gradle-wrapper.properties, etc.) support build and dependency management.
Relationships and Interactions
• Flow of user actions (like tapping a “Like” or “Send Comment”) leading through the UI to update underlying models.
• In testing, show how test suites interact with the core functionality (e.g., login, mood events).
Architectural Patterns and Design Principles
• Although the project’s structure suggests a standard Android application design, you might highlight patterns such as:
• Activity/Fragment design pattern for screen management.
• A ViewModel-based approach (indicated by HomeScreenViewModel) to separate UI logic.
• Possibly a modular design if different screens could be seen as separate “features.”
• Separation of concerns between UI, utility functions, and test code.
Technologies & Frameworks
• Integration with external design prototypes or documentation (e.g., Figma links in the README) to highlight design alignment.