Skip to content

Latest commit

 

History

History
54 lines (35 loc) · 2.54 KB

README.md

File metadata and controls

54 lines (35 loc) · 2.54 KB

MemorMe

MemorMe is an Android app that removes the physical burden of remembering what's important.

Features

  • Create memories using text and photo stories
  • Create simple collections to organize your memories
  • Easily search for and find collections and memories
  • Revisit your memories to always keep them with you

To Build

With Dart, Flutter, and Android Studio set up, run flutter pub get in the project directory, followed by flutter build apk.

Organization

All of the important code is located in the /lib directory. Here, we've organized our code into data, logic, pages, presentation, and widgets directories.

The data and logic folders contain the Dart business logic code, while the pages, presentation, and widgets folders contain the Flutter code that makes the app look good and react well.

The data folder contains our Memory and Collection data models, provider classes, and repositories.

The logic folder contains our Business Logic Components (BLoCs), which hold our business logic relating to the way the data is changed.

The pages folder contains the pages of the app.

The presentation folder contains theming, icons, and router code.

The widgets folder contains the smaller components that make up the pages.

One should start in the /lib/main.dart file.

Tests

Early on in our development, we were making use of test driven development. As we continued, our small team decided to focus on rapid prototyping and decided to abandon it. As such, most of the tests are not up to date or passing. They are located in the /test directory.

Libraries and Tools

MemorMe uses bloc & SQFlite for state management and Firebase Analytics & Firebase Crashalytics for analytics and monitoring.