Documentation

  2. Home
  4. Docs
  6. Documentation
  8. Core Modules
  10. Onboarding

Onboarding

The Onboarding code  lives in lib/ui This module is in charge of handling the user onboarding flow, such as:

  • the walkthrough flow
  • login
  • registration
  • welcome screen
  • country code picker
  • phone authentication
  • SMS code verification
  • Firebase Auth interactions
  • persistent login credentials
  • forgot and reset password
  • etc

There are 5 main UI components that reside in this module. So you need to change the code in here, if you have to make customizations in any of the following:

  • Walkthrough Screens (lib\ui\onBoarding\OnBoardingScreen.dart)
  • Welcome Screen a.k.a Landing Screen (lib\ui\auth\AuthScreen.dart)
  • Login Screen via Email and Password or Phone login  (with SMS verification) or Social login (lib\ui\login\LoginScreen.dart)
  • Sign up Screen via Email and Password or Phone Sign up (with SMS verification) (lib\ui\signUp\SignUpScreen.dart)
  • Reset password Screen via email (lib\ui\resetPasswordScreen\ResetPasswordScreen.dart)

Implementation wise, the onboarding module contains the following components:

  • UI screens
  • LoadScreen
    • this is the first screen of the app, and it decides how the initial UI should look like, based on the persistent login credentials as well as the persisted walkthrough impression flag