Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions STML/.env
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
OPENAI_API_KEY=''
1 change: 1 addition & 0 deletions STML/.eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
amplify-codegen-temp\models\models
65 changes: 65 additions & 0 deletions STML/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Miscellaneous
*.class
*.log
*.pyc
*.swp
.DS_Store
.atom/
.buildlog/
.history
.svn/
migrate_working_dir/

# IntelliJ related
*.iml
*.ipr
*.iws
.idea/

# The .vscode folder contains launch configuration and tasks you configure in
# VS Code which you may wish to be included in version control, so this line
# is commented out by default.
#.vscode/

# Flutter/Dart/Pub related
**/doc/api/
**/ios/Flutter/.last_build_id
.dart_tool/
.flutter-plugins
.flutter-plugins-dependencies
.pub-cache/
.pub/
/build/

# Symbolication related
app.*.symbols

# Obfuscation related
app.*.map.json

# Android Studio will place build artifacts here
/android/app/debug
/android/app/profile
/android/app/release

#amplify-do-not-edit-begin
amplify/\#current-cloud-backend
amplify/.config/local-*
amplify/logs
amplify/mock-data
amplify/mock-api-resources
amplify/backend/amplify-meta.json
amplify/backend/.temp
build/
dist/
node_modules/
aws-exports.js
awsconfiguration.json
amplifyconfiguration.json
amplifyconfiguration.dart
amplify-build-config.json
amplify-gradle-config.json
amplifytools.xcconfig
.secret-*
**.sample
#amplify-do-not-edit-end
42 changes: 42 additions & 0 deletions STML/.metadata
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# This file tracks properties of this Flutter project.
# Used by Flutter tool to assess capabilities and perform upgrades etc.
#
# This file should be version controlled and should not be manually edited.

version:
revision: "ba393198430278b6595976de84fe170f553cc728"
channel: "stable"

project_type: app

# Tracks metadata for the flutter migrate command
migration:
platforms:
- platform: root
create_revision: ba393198430278b6595976de84fe170f553cc728
base_revision: ba393198430278b6595976de84fe170f553cc728
- platform: android
create_revision: ba393198430278b6595976de84fe170f553cc728
base_revision: ba393198430278b6595976de84fe170f553cc728
- platform: ios
create_revision: ba393198430278b6595976de84fe170f553cc728
base_revision: ba393198430278b6595976de84fe170f553cc728
- platform: macos
create_revision: ba393198430278b6595976de84fe170f553cc728
base_revision: ba393198430278b6595976de84fe170f553cc728
- platform: web
create_revision: ba393198430278b6595976de84fe170f553cc728
base_revision: ba393198430278b6595976de84fe170f553cc728
- platform: windows
create_revision: ba393198430278b6595976de84fe170f553cc728
base_revision: ba393198430278b6595976de84fe170f553cc728

# User provided section

# List of Local paths (relative to this file) that should be
# ignored by the migrate tool.
#
# Files that are not part of the templates will be ignored by default.
unmanaged_files:
- 'lib/main.dart'
- 'ios/Runner.xcodeproj/project.pbxproj'
112 changes: 112 additions & 0 deletions STML/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
## Minder

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

## Table of Contents
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [Development](#development)
- [License](#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](https://code.visualstudio.com/)

2. **Flutter SDK:**
- The app is built using Dart with Flutter. Make sure you have Flutter SDK installed.
- [Flutter Installation Guide](https://flutter.dev/docs/get-started/install)

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](https://dart.dev/)

4. **External APIs:**
- The app utilizes external APIs for conversation analysis (Chat GPT) and transcription (Wispher).
- [Chat GPT Documentation](https://chatgpt.com/documentation)
- [Wispher API Documentation](https://wispher.io/api-docs/)

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](https://aws.amazon.com/getting-started/)

5. ** AWS Amplify:**
## AWS Amplify Configuration

To enhance Minder with cloud functionalities, we use AWS Amplify. Follow these steps to configure AWS Amplify for the app:

### Setting Up AWS Amplify

- **Install the Amplify CLI:**
- Ensure you have Node.js installed on your machine. Then, install the AWS Amplify CLI globally using npm:
```bash
npm install -g @aws-amplify/cli
```

- **Configure Amplify:**
- Run the following command and follow the prompts to configure the CLI with your AWS account:
```bash
amplify configure
```
- Sign into the AWS Management Console when prompted and complete the configuration steps.

- **Initialize Amplify in your project:**
- Navigate to your project directory and initialize Amplify:
```bash
amplify init
```
- Answer the questions to specify the name of your environment, your preferred text editor, and other configuration options.

- **Add Amplify Categories:**
- Add any required categories (e.g., auth, api, storage) to your project. For example, to add authentication, you can use:
```bash
amplify add auth
```
- Follow the prompts to configure each category according to your needs.

- **Push Changes to the Cloud:**
- Apply your changes and deploy your backend to the cloud with:
```bash
amplify push
```

Please refer to the [AWS Amplify Documentation](https://docs.amplify.aws/) for more detailed instructions and advanced configurations.


## Installation

Follow these steps to set up and run the app:

1. Clone the repository to your local machine:

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

flutter pub get

flutter run




## Team Members ✨
- [@ElsaBushen](https://github.com/ElsaBushen)
- [@LensaGemeda](https://github.com/LensaC)
- [@JohnnGuyen](https://github.com/Johnnguyen616)
- [@GabrielMoreno](https://github.com/MrGESM)
- [@SayedShahMahbobi](https://github.com/Mahbobi)
- [@KathleenHampton](https://github.com/kbrig573)
- [@VinroyJones ](https://github.com/geajonesv)
- [@HellenOjwang](https://github.com/Hellenoj)


28 changes: 28 additions & 0 deletions STML/analysis_options.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# This file configures the analyzer, which statically analyzes Dart code to
# check for errors, warnings, and lints.
#
# The issues identified by the analyzer are surfaced in the UI of Dart-enabled
# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be
# invoked from the command line by running `flutter analyze`.

# The following line activates a set of recommended lints for Flutter apps,
# packages, and plugins designed to encourage good coding practices.
include: package:flutter_lints/flutter.yaml

linter:
# The lint rules applied to this project can be customized in the
# section below to disable rules from the `package:flutter_lints/flutter.yaml`
# included above or to enable additional rules. A list of all available lints
# and their documentation is published at https://dart.dev/lints.
#
# Instead of disabling a lint rule for the entire project in the
# section below, it can also be suppressed for a single line of code
# or a specific dart file by using the `// ignore: name_of_lint` and
# `// ignore_for_file: name_of_lint` syntax on the line or in the file
# producing the lint.
rules:
# avoid_print: false # Uncomment to disable the `avoid_print` rule
# prefer_single_quotes: true # Uncomment to enable the `prefer_single_quotes` rule

# Additional information about this file can be found at
# https://dart.dev/guides/language/analysis-options
1 change: 1 addition & 0 deletions STML/devtools_options.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
extensions:
5 changes: 5 additions & 0 deletions STML/flutter_launcher_icons.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
flutter_icons:
android: true
image_path: "asset/images/minderlogo2.png"
adaptive_icon_background: "#FFFFFF"
adaptive_icon_foreground: "asset/images/minderlogo2.png"
Loading