“Teacher App UI” Documentation by “DevsBeta” v1.0

---

“Teacher App UI”

---

Table of Contents

1. Requirement
2. File Structure
3. Installation
   • Install flutter on windows
   • Install flutter on mac
4. App Configuration

---

A) Requirement - top

This project have required following dependency

Flutter Requirements

1. Android Studio: Electric Eel
2. Flutter: 3.x

---

B) File Structure - top

General file structure of the app

---

C) Installation - top

Install flutter on windows

• Download Android Studio Click here
• Get the Flutter SDK
  1. Install https://flutter.dev/docs/get-started/instal

     Extract the zip file and copy flutter folder into your desired installation location for the Flutter SDK (eg. C:\src\flutter; do not install Flutter in a directory like C:\Program Files\).

     
  2. Now set your environment variable
  3. From the Start search bar in , type ‘env’ and select Edit environment variables for your account
  4. Under User variables check if there is an entry called ‘path’
  5. Click on Edit. New Dialog open from it click on new and copy full path to flutter\bin as its value
  6. Now Restart your pc for changes to take effect
  7. Open cmd and run flutter doctor as shown below
  8. Now open Android Studio and create new flutter project then select your flutter sdk file to the location where we have downloaded earlier and that's it.
  9. Learn more about Android Studio - Click here

Install flutter on mac

• Download Android Studio - Click here
• Download Xcode - Click here
• Get the Flutter SDK - Click here
  1. Install - Click here

     Extract downloaded file, just double click on that. and just copy extracted folder and paste it to your desired location (for example, Documents\flutter).

  2. Update your path
     Warning

     Path variable needs to be updated to access “flutter” command from terminal. you can just update path variable for current terminal window only. and if you want to access flutter commands from anywhere in terminal, we need to update SDK path permanently.

     To update PATH variable, we need to open terminal.

     To update PATH variable for current terminal window only, then enter this command "export PATH="$PATH:`pwd`/flutter/bin"" and hit enter key.

     To update PATH variable permanently, then Open or create .bash_profile file. to open or create that file, then enter "sudo open -e $HOME/.bash_profile" and hit enter key.

     Append below line to bash_profile file at bottom of all other content. "export PATH="$PATH:[PATH_TO_FLUTTER_GIT_DIRECTORY]/flutter/bin"" as [PATH_TO_FLUTTER_GIT_DIRECTORY] is actual path of SDK folder.

     Run this command on terminal "source $HOME/.bash_profile" to refresh PATH variables.

     Then check whether our SDK is successfully installed or not.

     You are now ready to run Flutter commands in the Flutter Console!

     Run "flutter doctor" into terminal, If you are getting check list of flutter sdk requirements, it means SDK is successfully installed on your machine. and you can start building flutter apps on your machine.

     If you find any issue during environment setup in macos, please go online - Click here

---

D) App Configuration - top

• Change App Name

  

• Change App Icon

  1. Replace app_icon.png in assets/images folder
  2. Run flutter pub get command in android studio terminal
  3. Run flutter pub run flutter_launcher_icons command
  

• Change Package Name

  1. Run flutter pub get command in android studio terminal
  2. Run flutter pub run change_app_package_name:main com.new.package.name