App Docs

 

Requirement

This project have required following depandency

Flutter/iOS Requirements

1. Android Studio: 4.1.2
2. Flutter: 2.10

PHP Requirements

1. PHP >= 7.0
2. MySQL >= 5.6
3. Apache HTTP server
4. OpenSSL PHP Extension

File Structure

Here is the general File structure of the template:

• app
• lang
• lib
• models
• network
• screens
• store
• utils
  •  Colors.dart
  •  Common.dart
  •  Constant.dart
•  pubspec.yaml

Installation

---

Install flutter on windows

• Download Android Studio

  Click here

• Get the Flutter SDK

  1. Install https://flutter.dev/docs/get-started/install 
     

     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. Update your path 
     
  3. Now set your enviournment variable
  4. From the Start search bar in , type ‘env’ and select Edit environment variables for your account
  5. Under User variables check if there is an entry called Path:
  6. Click on Edit. New Dialog open from it click on new and copy full path to flutter\bin as its value
  7. Now Restart your pc for changes to take effect
  
  
  8. Now check everything is ok or not
  9. open cmd and run flutter doctor as shown the below picture
  
  
  10. 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
  
  
• 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

Install flutter on linux

• Download Android Studio - 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.

     You’ll probably want to update this variable permanently, so you can run flutter commands in any terminal session. To update PATH variable, we need to open terminal.

     1	export PATH="$PATH:[PATH_TO_FLUTTER_GIT_DIRECTORY]/flutter/bin"

     1. Run source $HOME/. to refresh the current window, or open a new terminal window to automatically source the file.
     2. Verify that the flutter/bin directory is now in your PATH by running:

     1	echo $PATH

     Verify that the flutter command is available by running:

     1	which flutter

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

PHP Setup & Admin Panel Configuration

Installation instruction

• Unzip the mightyradio.zip file and ONLY use the extracted /mightyradio folder and upload in below directory based on your server

• In Linux

  Path: var/www/html/

• In cPanel

  Inside File manager -> Path: public_html/

• Create the database on your server Import mightyradio.sql file in created database. ( Note : Only necessary for those client, who is setup project first time. )

For database settings, open the configuration/Connection.php file with a text editor and set your database settings.

Enter database name, database username, database password and the host details

Admin credentials

Email : admin@admin.com

Password : admin

Admin Panel Configuration

App Configuration

First go to the Web App Configuration Form and fill details which you want for your app.

Ads Configuration

Select Ads Type

You can select one ads type, which you want to display in your app. If don't want to display ads then select None.

---

Admob Configation

AdMob Banner Unit ID-Android

This field is for showing AdMob banner ads on your app. If you don't want to show google AdMob just keep it blank. If you want AdMob then don't forget to add meta-data on your AndroidManifest file.

AdMob Interstitial Unit ID-Android

This field is for showing AdMob interstitial ads on your app. If you don't want to show google AdMob just keep it blank. If you want AdMob then don't forget to add meta-data on your AndroidManifest file.

AdMob Banner Unit ID-iOS

This field is for showing AdMob banner ads on your app. If you don't want to show AdMob just keep it blank.

AdMob Interstitial Unit ID-iOS

This field is for showing AdMob interstitial ads on your app. If you don't want to show AdMob just keep it blank.

---

Facebook Audiunce Configation

Facebook Audiunce placement ID-Android

This field is for showing Facebook Audiunce banner ads on your app. If you don't want to show Facebook Audiunce just keep it blank. If you want AdMob then don't forget to add meta-data on your AndroidManifest file.

Facebook Audiunce placement ID-Android

This field is for showing Facebook Audiunce ads on your app. If you don't want to show Facebook Audiunce just keep it blank. If you want AdMob then don't forget to add meta-data on your AndroidManifest file.

Facebook Audiunce placement ID-iOS

This field is for showing Facebook Audiunce banner ads on your app. If you don't want to show Facebook Audiunce just keep it blank.

Facebook Audiunce placement ID-iOS

This field is for showing Facebook Audiunce interstitial ads on your app. If you don't want to show Facebook Audiunce just keep it blank.

OneSignal Configuration

Set Onesignal app id and rest api key for Onesignal Configuration.

Send Onesignal notification

Update Profile & Change Password

Configuration

---

Android Configuration

Change Application Name

Open /android/app/src/main/AndroidManifest.xml and specify your application name.

Change Application Icon

1. Open Android studio. Select File -> open -> select root folder -> android
2. Wait for indexing
3. Right click on res -> New -> Image asset
4. Now the following window will open once we click on Image Asset:


Please don't change the icon name.

5. Once all the required changes are made, Click on the Next button and then on Finish and then the icon of the app will be changed!

Change Application ID

1. Open Android studio. Select File -> open -> select root folder -> android
2. Wait for indexing
3. Open /android/app/build.gradle file and change YOUR_APP_ID
4. after making changes sync your Project

Setup Firebase

1. For Firebase setup, you just need to change the android/app/google-services.json file.
2. Create a new firebase account, register your application with your package name.
3. Now download the google-services.json file and replace with current.
4. Refer to Link

Setup AdMob

1. For AdMob setup, you just need to change the app id in android/app/src/main/AndroidManifest.xml file
2. For that, you have to create a firebase account and create a new application in AdMob. and then you will get application id.

Now, replace value with your new generated application id.



3. Now run the application. your ads are now live.

Generate Signed APK && AAB

1. Go to your project -> Tools -> Flutter -> Open for Editing in Android Studio as shown below


2. Open Project in New Window
3. Wait for while until project synchronization. After that Go to Build -> GenerateSigned Bundle/APK...


4. Select Android App Bundle or APK Option as per your need. (Android App Bundle is best solution) and click Next button.


5. Select Create new.. option to generate new Signed key (When you release your app First Time) and Fill all options. Refer this link



6. Click Next button and you will get following screen...



Select Build variants - release and Signature versions both V1 and V2 respectively as shown above screen shot and click Finish button.

7. Wait for a while until Gradle Build Running process complete.and finally you will get the Generate Signed APK : (APKs) generated successfully. from that click on Locate option to get Location of your Generate Signed APK Key.

 

iOS Configuration

Open Project in Xcode

1. Open Xcode.
2. Select Open another Project.
3. Open the iOS directory within your app.
4. Now, click on Done button.

Change Bundle Name

1. Select your project file icon in Group and files panel.
2. Then Select Target -> Info Tab.
3. At last change Bundle Name.

Change Bundle Identifier

Bundle Id is a unique Identifier of your of app on iOS and MacOS. iOS and MacOS use it to recognise updates to your app. The identifier must be unique for your app.

1. Select your project file icon in Group and files panel.
2. Select General Tab.
3. After Select General tab you can see the details of your application.
4. In Identity section, rename your Bundle identifier.

Change App Icons

1. see How to Generate App Icons?
2. In Group and files panel find “Assets.xcassets” folder.
3. In Assets.xcassets folder replace AppIcon.

Change App Id

Change App Id

1. Open Xcode,Select the Info.plist from the file Manager.
2. Change the GADApplicationIdentifier value.

1 2	<key>GADApplicationIdentifier</key> <string>Add your Admob appId</string>

Flutter Configuration

---

Change Base URL

In main directory goto the lib -> utils -> constant.dart file and repalce the URL at line number 6.

Change Primary Color

In main directory goto the lib -> utils -> color.dart files and change it.

Change One Signal Key

In main directory goto the lib -> utils -> constant.dart file and add the Key at line number 21.

OneSignal Configuration

• Create onesignal project in your account Choose android platform


• Go to your Firebase Console-> Project Settings -> Cloud Messgaing and copy 'Server Key' and 'Server ID'


• Now paste those values one by one here


• Choose Target SDK as Flutter


• Now copy App ID as shown below


• go to \lib\utils\AppConstants.dart and change 'YOUR_ONESIGNAL_KEY'


• You have connected android application to your Onesignal account successfully

How to change OneSignal Logo

1. You can genrate and download your onesignal logo to Click here
2. Add Downloaded folder in your project in android/app/src/main/res folder

How to integrate firebase

• Create new project to your firebase console







• Add andorid application to your firebase project



• Add package name and sha-1 key (sha-1 optional for now)







• You have connected andorid application to your firebase project successfully
• Now download the google-services.json file and replace with current.


• Add ios application to your firebase project


• Get your bundle id from \ios\Runner.xcodeproj\project.pbxproj file or search for PRODUCT_BUNDLE_IDENTIFIER and you will get following result


• Enter your ios bundle id




• You have connected ios application to your firebase project successfully

How to create admob account

• In the Admob console, click add android app from the Apps menu.


• Enter your app name and Enabling user metrics is not necessary to complete this codelab. However, we recommend that you do because it allows you to understand user behavior in more detail and click on ADD APP button.


• Create ad units.


• Select Banner unit ad and enter banner unit ad name then click on Create ad Unit button. Same procedure follow to create Interstitial ad)


• Then add another unit add shown in below image and Same as above create Interstitial ads and native ads.


• Same as Add iOS app and same as add units in iOS app.
• Add your ad unit id same way explain in previous step : Like this

Common error

---

No matching client found for package name

• The error is "package_name" in google-services.json is not matching with your "applicationId" in app gradle.
• Just make sure the package_name and applicationId both are same.

Flutter SDK Not Available

Download the SDK and point the SDK folder path in your future projects.

There are different sources you can try

1. You can clone it from the Github Repository
2. Download SDK zip file + extract it after downloading
3. You can also Download any version(including older) from here (For Mac, Windows, Linux)

Use the SDK path in your future projects

Update the existing code with new release

---

Special Notes

As per envato policy installation, setup and configurations or modification are not included in free support. Free support is only for any bug/ error in original code. we do not provide installation and customization support in FREE SUPPORT.
Still, We are providing steps for How to update future release code to existing source code for your knowledge purpose.

PLEASE DO NOT CREATE TICKETS IF YOU FACE ANY ISSUE DURING UPDATE YOUR CODE. WE WILL NOT PROVIDE ANY SUPPORT ON THAT.

---

How to update future release code to existing source code

If you want which file changes are on the latest updated version then you have to manage the git repository by yourself.

For First time: Initial project downloaded from codecanyon server.

Step 1: Create or login with gitlab

Login or register your account with gitlab: https://gitlab.com/users/sign_in

Step 2: Create a new project in GitLab

• In your dashboard, click the green New project button or use the plus icon in the navigation bar. This opens the New project page.
• On the New project page -> Create a blank project.

Step 3: Clone your project to your local system

• 1. Once project is created on your gitlab server. You have to clone the project to your local system. You can clone it with the command line.
• 2. git clone “repository path”
• 3. Copy your project url and clone into your exiting system



• 4. Once successfully clone then system will create a folder on your system

Step 4: Download project from codecanyon server Step 5: Copy/paste your initial downloaded project to clone directories.

Once successfully downloaded project from codecanyon, copy/paste your downloaded project into clone directories

• Note
• Only orignal source code is put here.

Step 6: Commit and push to gitlab server

Onces copy/paste your changes to clone directres, you have to push all files to your gitlab server. For that use the following commands.

Before commit to server directores, you have to remove below folder from your project

• 1. build
• 2. .idea
• 3. .gradle

After That follow below steps

• 1. Goto inside your clone directory project

• 2. Add your all files with “git add .” command
• 3. Now commit your changes with below command
• 4. git commit -m ‘initial commit’
• Note
• Write your latest version message instead of “initial commit”.

• 5. Push your changes to server with below command

“git push” And provide you gitlab credential details


• 6. Check your all changes to gitlab server

---

For Update existing code (If Already have old version of project)

Note

If you remove the project from the local system then clone the project again from your gitlab server. Follow the same above Step 3: Clone your project to your local system

Step 1: Download the latest version from codecanyon server.

Once you will received mail for updates. Just download latest code from codecanyon server.

Step 2: Copy/paste your initial downloaded project to clone directories.

Once successfully downloaded project from codecanyon, copy/paste your downloaded project into clone directories

Note

Only orignal source code is put here.

Step 3: Commit and push to gitlab server

Follow same Step 6: Commit and push to gitlab server

Step 4: Check updated files

After committing your latest changes. Goto the gitlab project dashboard and click on the commit link.

Click on link which you have commit message on above steps 3

Now check the all changed file.

Click on “XYZ changed file” to see which file has been changed.