Flutter Documetation Task

[omarokasha1]

We need to have like the backend a clear Description for the Flutter Code Structure What is each file and how can manipulate the code the same task @omda07 Asked to do we need to make the same at FLutter .

**_

• [ ] So please @mirette3 we need an Expected time to can check these things developed , clear and Added to @youssefelgebaly Documentation in the readme file

_**

@youssefelgebaly Youssef you need to get these details from Flutter Team and Backend team and add them to your documentation

[youssefelgebaly]

The Flutter Code Structure

• layout
  • layout.dart
• models
  • chage_password_model.dart
  • course_model.dart
  • login_model.dart
  • on_boarding_model.dart
  • register_model.dart
  • user.dart
• modules
  • authertication
  • courses
  • my_learning
  • notification
  • onboarding
  • profile
  • search
  • home_screen.dart
  • splash_screen.dart
• shared
  • component
  • cubit for internet
  • network
  • themes
• main.dart

Naming method

Rely on small letters and separate words with _

layout file

This file includes a fixed screen to which the bottom navigation bar or the appbar can be added, and moving between more than one screen in the body

Models

This file includes models for each screen stored in the data used in this screen in short is the data warehouse that is used

Modules

This file includes screen files from widget and state management

• authertication

  This file includes login file, register file, forget password file and change password file

• courses

  This file includes two screens, one for viewing the contents of the course course_overview_screen.dart and the other for viewing the course course_details_screen.dart

• my_learning

  This file includes the screen of the courses that you have subscribed to

• notification

  This file contains the notifications screenshot

• onboarding

  This includes welcome screen. this screen appears when you open the app for the first time

• profile

  This file contains the user information and modification

• search

  This file includes screen appears when chick in text from filed search

• home_screen.dart

  This screen is the main screen in the application that appears after loging in

• splash_screen.dart

  This screen is the intro that shows the logo and the name of the application

  shared

  This includes everything that is const in the application such application themes, component in app, and network file this include local database and remote database