Minder

A memory support app for short-term memory loss individuals, using video recording and transcription for personalized memory aids. Reminds and revisits crucial moments effortlessly.

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contributing
• Development
• License

Getting Started

Before you can run and use this Flutter app, make sure you have the following software and tools installed.

Prerequisites

List any software or tools that users need to install before using your app. Include links to their official documentation.

1. Visual Studio Code (VS Code):

   • We recommend using Visual Studio Code as the integrated development environment (IDE) for working with Flutter.
   • Download Visual Studio Code

2. Flutter SDK:

   • The app is built using Dart with Flutter. Make sure you have Flutter SDK installed.
   • Flutter Installation Guide

3. Dart SDK:

   • Dart is the programming language used with Flutter. It is included with the Flutter SDK, so you don't need to install it separately.
   • Dart Documentation

4. External APIs:

   • The app utilizes external APIs for conversation analysis (Chat GPT) and transcription (Wispher).
     • Chat GPT Documentation
     • Wispher API Documentation

5. AWS Account:

   • For cloud-based storage, we use AWS (Amazon Web Services). You'll need an AWS account to set up and configure cloud storage functionalities.
     • AWS Documentation

6. Amplify CLI:

   • Amplify provides a set of tools and services that can be used together or on their own, to help front-end web and mobile developers build scalable full stack applications, powered by AWS.
   • Install the Amplify CLI globally on your machine to configure backend resources such as authentication, API, and storage.
   • Amplify CLI Installation Guide

Installation

Follow these steps to set up and run the app:

1. Clone the repository to your local machine:

   git clone https://github.com/umgc/minder.git
   cd minder