Afrostories

Getting Started

If Your machine is not setup for Flutter Development (i.e. Android studio, Flutter, Dart, and Flutter Plugin is installed), follow this guide: https://flutter.dev/docs/get-started/install.

git clone git@github.com:Afrostories/timeline.git
abw login --scopes=dev_tools
abw install_git_hooks
abw pull_constants
flutter run

API Generation

Go to https://dev.afrostories.org/openapi/timeline/edit Update OpenAPI Specification as necessary, Save, and Generate new SDK

Testing

https://reports.afrostories.org

Style Guide

Follow this guide: https://dart.dev/guides/language/effective-dart/style

Additional Documentation

https://docs.google.com/document/d/1qgkB4fL0x641v-RQD05binoTj5h8Nc2PVaVL_2GelUo/edit?usp=sharing

Libraries

authentication: Handles sign in, sign up, and forgot password
common: Helper classes and functions
content: Classes in this library present the UI for all the domain models in the application.
donate: Classes related to presenting a map view
engage: Functionality to help engagement presentation
launch: Entry point for the application
maps: Classes related to presenting a map view
media: Classes related to presenting the media player
service: Contains the business logic for connecting data to UI
url: Launch system web browser
user: Contains classes used to manage the user profile