MindKeep
readme.md

MindKeep

Overview

Welcome to MindKeep, an Android application built with Jetpack Compose. This project is the result of our academic capstone effort to develop a modern, user-friendly app designed to support individuals living with memory impairment with guidance using augmented reality.

This project represents a migration from Xamarin to Android Jetpack Compose and incorporates input from a domain expert—a clinical psychologist—to ensure its usability and effectiveness.

Features

  • Tasks and Routines: Create and manage tasks and routines effortlessly. Users can choose from pre-made templates with built-in reminders or customize their own from scratch.
  • Augmented Reality Integration: Leverages ARCore to enhance interactions, providing an engaging and innovative way to navigate and complete daily tasks and routines.
  • Collaborative Support: Enables connection between Primary Users and Supporters, allowing Supporters to view and assist with tasks while fostering accountability and encouragement.
  • Progress Tracking: View daily, weekly, and monthly progress through visualized data. Both Users and Supporters can monitor task completion trends to identify behavioral changes or improvements.
  • Modern UI: Designed using Jetpack Compose for an intuitive and responsive experience.

Creating a task Creating a path Supporter view

Installation

Prerequisites

  • Google Play Services: Ensure the device supports and has Google Play Services installed.
  • Android 8.1 or higher: ARCore requires Android Oreo or later.
  • Permissions: Internet, Camera, and ARCore permissions must be granted.

Steps

  1. Clone this repository:
    git clone https://github.com/Sher-MindKeep/MindKeepCompose.git
    
  2. Add your google-services.json file to the app/ directory. This file is required for Firebase and Google APIs.
  3. Open the project in Android Studio.
  4. Sync Gradle to download dependencies.
  5. Build and run the project on an ARCore-compatible Android device.

Usage

After launching the app:

  1. Grant the required permissions (Internet, Camera, ARCore).
  2. Explore the features such as AR experiences, creating tasks and reminders, as well as keeping tabs of primary users if you are a Supporter.

Technical Details

Migration

This app was originally developed using Xamarin and later migrated to Jetpack Compose to leverage Android's latest features and improve performance.

Key Dependencies

  • Jetpack Compose: UI Toolkit for building native Android interfaces.
  • ARCore: Provides augmented reality capabilities.
  • Firebase: Backend services for authentication, database, and analytics.

Development Team

This project was developed as a capstone project by:

  • Jerikka Sotelo: Product Owner, Lead Developer
  • Teeba Al-Khishman: Risk Analyst
  • Tu Minh Diep: Scrum Master

Acknowledgments

  • Thanks to our capstone supervisors, Dr. Volodymyr Voytenko and Magdin Stoica, for their guidance, support, and constructive feedback throughout the project.
  • Special thanks to Dr. Kate Dupuis, a clinical psychologist, for providing invaluable insights and guidance that shaped the app's usability and relevance to the domain.
  • We also extend our gratitude to David Horachek for sharing their expertise on augmented reality.

Limitations & Known Issues

  • The app requires a stable internet connection for certain features.
  • The google-services.json file is excluded from the repository due to security reasons; it must be provided separately.
  • Compatibility is limited to devices that support ARCore.

Contributing

Currently, contributions are not accepted as this is an academic project in beta release. However, feedback and suggestions are welcome! Feel free to open an issue for bugs or enhancements.

Contact

For questions or feedback, please contact: