0% found this document useful (0 votes)
63 views

Academy-LMS-Instructor-Flutter-App-Developer-Documentation

Uploaded by

tamer mahfouz
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
63 views

Academy-LMS-Instructor-Flutter-App-Developer-Documentation

Uploaded by

tamer mahfouz
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 6

Academy Instructor App

Course-Based Learning Management System.

Developer Documentation
All Right Reserved To Creativeitem 2022.
Index

Contents:
● Introduction
● Prerequisites
● Syncing Instructor App with Academy-LMS Web App
● Build the apk file
● Build for iOS
● Distribution
○ Manual Distribution
○ Publishing on Google Play
○ Publishing on App Store iOS
● Source code Structure
1. Introduction
a. Welcome to the Academy Instructor application. Admin should
pay a bit more attention while reading this documentation.

2. Prerequisites
a. For running the application, Admin has to fill some prerequisites.
Like:

i. Admin should have Academy Web Application hosted on a


live server.
ii. The web application must be in the latest version always.

3. Syncing Academy Instructor Flutter App with Academy


Web App
a. If the admin does have the Academy web application, he can sync
the mobile app now.
b. Download the instructor flutter app from codecanyon.
c. Install flutter on your platform using this link -
https://flutter.dev/docs/get-started/install
d. Download the Android Studio or VSCODE.
e. Open the downloaded mobile app with Android Studio/VSCode
ide.
f. Open the file name “constants.dart”. Which is located at “lib/”.
g. Move to line number 4.
h. You will find a variable declared called “BASE_URL”
i. Provide your hosted academy application on the placeholder
“your_application_url_will_be_here”. Make sure it’s inside the
quotation marks. Let’s say if your application is hosted on
http://demo.creativeitem.com/academy, after entering your
application url, it will look like this:

const BASE_URL= “https://demo.creativeitem.com/academy”


4. Build the application

a. If you have done this good so far, Now go to the project


terminal. Run flutter pub run zoom:unzip_zoom_sdk from the
terminal. It will download some required files.

b. If you have done this well so far, You will find the build option on the
top navigation menu. Or,

Go to the terminal. Run flutter run from the terminal. It will build a
debug apk.

Go to the terminal. Run flutter build apk from the terminal. It will build a
release apk. Or,

Go to the terminal. Run flutter build apk --target-platform


android-arm,android-arm64,android-x64 --split-per-abi from the terminal. It
will build a release apk with reduced size.

If “Keystore file not set for signing config release” error occurred, then
follow this link to set the Keystore file:

“https://docs.flutter.dev/deployment/android”

Or you will find tons of supporting videos and blogs on the internet
like this
https://www.youtube.com/watch?v=dR04ArAhxd4&ab_channel=GoogleDeveloper
s

5. Distribution

a. Manual Distribution

i. If you have built it successfully, you will find the apk file inside:
“build/app/outputs/flutter-apk/app-release.apk”. You can distribute
this application manually by hosting it on your server or somewhere
else.
b. Google Playstore

i. You can host the application on the Google Play store as well. You
will find tons of supporting videos and blogs on the internet like this
https://www.youtube.com/watch?v=dR04ArAhxd4&ab_ch
annel=GoogleDevelopers

Follow whichever you feel is easier.

c. App Store iOS

i. You can host the application on Apple Store as well. You will find
tons of supporting videos and blogs on the internet like this
https://www.youtube.com/watch?v=MxejThYFDdY&ab_ch annel=DarranKelinske

Follow whichever you feel is easier.

6. Source code Structure


a. Here is the source code structure of the Instructor application

All the screens we’ve used are in the screens folder. All the providers
are inside the providers folder. All the widgets we’ve used are inside
the widgets folder. providers are holding some of the servers. Models
are holding all the data models we’ve used here. Main.dart file
contains all the routes. Android and ios folders contain android and
ios related files respectfully. You can open the contents of the ios
folder from Xcode in order to change app icons and splash screens.
Related android content in the Android folder.

You might also like