4030 Project Group 3 - Scam Boyz

Members: Amanda Hahn, Nicholas Waller, Benjamin Bliss, Uladzislau Kaparykha

How to run:

• Start Android Emulator
  • this project is expected to run with Android emulator
  • behaviour under other environments is undefined
• while CWD is 4030-group-project, run flutter put get .
  • this will install all required non-default packages the app is using (sqlflite, table_calendar, ...)
• Either:
  • in terminal, run flutter run (and follow instructions if relevant); or
  • in VSCode (with Flutter extention), under /lib/main.dart, right above main() click Run or Debug
• App will be launched in the appropriate environment

Assumtions/Limitations:

• We are using a number of non-standard packages, which will need to be installed before running the program
• The application was made with Android in mind; iOS and Web versions have not been tested

Project Structure:

4030-group-project ├─> {standard Flutter project setup/boilerplate} ├─ pubspec.yaml │ └─> defined dependencies for the project └─ lib ├─> apart from the other "default Flutter project setup", only relevant dir to be looked at for these purposes ├─ main.dart │ └─> defines GoRouter structure to be used within the app, and builds the app from main() ├─ calendar/ │ ├─ ...
│ └─> has all the content (widgets, pages, helpers) relevant to Calendar functionality; ├─ common_widgets/ │ ├─ ...
│ └─> contains widsgets that are used multiple times throuout the app ├─ flashcards/ │ ├─ ...
│ └─> has all the content (widgets, pages, helpers) relevant to Flashcard functionality; ├─ home/ │ ├─ home.dart
│ └─> has implementation of the Home screen; └─ utilities/ ├─ ...
└─> contains utilities and helpers used across the app; contains db implementation;