Skip to content

Latest commit

 

History

History
52 lines (41 loc) · 2.42 KB

setup.md

File metadata and controls

52 lines (41 loc) · 2.42 KB
Raw

Setup

  • BalanceMe, despite having a relatively small number of screens, can be difficult to set up. The purpose of this section is to explain the requirements for installing and using BalanceMe and its files. failure to install and set up any of the following package may result in undefined behaviour

Requirements

Dart IDE Flutter sdk-version 2.14.0 and above Kotlin- version 1.6.0 and above

Dependencies and packages

Firebase packages-firebase_core,firebase_auth,cloud_firestore,firebase_storage,firebase_analytics in addition requires a firebase account, more information in https://firebase.flutter.dev/

Provider- for listeners and changing app states to save correctly https://pub.dev/packages/provider

For choosing a profile image in settings, as well as choosing an attached image: Image_picker- for choosing a profile image in settings https://pub.dev/packages/image_picker Permission_handler- for requesting permission when accessing a user's gallery, or camera Cross_file-https://pub.dev/packages/cross_file Cached_network_image-https://pub.dev/packages/cross_file

For charts in balance page, as well as archive: Percent_indicator- from https://pub.dev/packages/percent_indicator/install Syncfusion_flutter_charts- from https://pub.dev/packages/syncfusion_flutter_charts/install

Sentry_flutter- for catching and documenting exceptions, requires sign-in and following instructions in sentry.io

For third party sign in functionality and matching buttons: Flutter_signin_button-https://pub.dev/packages/flutter_signin_button Google_sign_in-https://pub.dev/packages/google_sign_in Auth_buttons-https://pub.dev/packages/auth_buttons Flutter_facebook_auth-requires Facebook for developer's account https://pub.dev/packages/flutter_facebook_auth

For workspace and network functionality Cross_connectivity-https://pub.dev/packages/cross_connectivity Rxdart-https://pub.dev/packages/rxdart

Packages for widgets: Awesome_dropdown-https://pub.dev/packages/awesome_dropdown/example Syncfusion_flutter_datepicker-https://pub.dev/packages/syncfusion_flutter_datepicker/example Sorted_list-https://pub.dev/packages/sorted_list Email_validator-https://pub.dev/packages/email_validator Rating_dialog- https://pub.dev/packages/rating_dialog Mailer-https://pub.dev/packages/mailer Share_plus-https://pub.dev/packages/share_plus Flutter_masked_text-https://pub.dev/packages/flutter_masked_text2