“SBurK” Documentation v2.6

---

“Android Apps for Parents and Drivers”

---

Table of Contents

1. What is SBurK?
2. Parent App
3. Driver App
4. Firebase setup
5. Ad setup
6. FAQ

---

A) What is SBurK? - top

SBurK is a comprehensive system for school bus tracking that manages the daily school bus operation. SBurK consists of three sub systems, which are

• Laravel admin web panel
• Android mobile app for parents
• Android mobile app for drivers
• Firebase setup

Here we present the Android mobile apps for parents and drivers

I strongly recommend to setup the backend first, then the mobile apps.

---

B) Parent App - top

In order to build the android app for parents correctly, please make sure that you have accounts for

• Google maps SDK
• Firebase Cloud Messaging

Please install Android Studio 3.5 or above, then open it and follow the following steps

1. Go to file-> open and go to the location of the purchased "SchoolBusTracker" folder
2. In the left pane, open gradle-wrapper.properties file
3. Make sure that you set the gradle version to 7.2 in the last line of the file

distributionUrl=https\://services.gradle.org/distributions/gradle-7.2-all.zip

4. In the left pane, open "Util.java" file
5. Change the value for the variable "WEB_SERVER_URL" with your backend url
6. Change the value for the variable "WEB_SOCKET_SERVER_HOST" with your laravel-echo-server url
7. Change the value for the variable "WEB_SOCKET_SERVER_PORT" with your laravel-echo-server port number

8. Mapbox setup

• Before installing the SDK, you will need to gather the appropriate credentials. The SDK requires two pieces of sensitive information from your Mapbox account. If you don't have a Mapbox account: sign up and navigate to your Account page. You'll need:

  • A public access token: From your account's tokens page, you can either copy your default public token or click the Create a token button to create a new public token.
  • A secret access token with the Downloads:Read scope.
    1. From your account's tokens page, click the Create a token button.
    2. From the token creation page, give your token a name and make sure the box next to the Downloads:Read scope is checked.
    3. Click the Create token button at the bottom of the page to create your token.
    4. The token you've created is a secret token, which means you will only have one opportunity to copy it somewhere secure.
• Put the secret token in place of MAPBOX_DOWNLOADS_TOKEN in the settings.gradle file

• Put the public token in the strings file

---

C) Driver App - top

In order to build the android app for drivers correctly, please make sure that you have accounts for

• Google maps SDK

Please install Android Studio 3.5 or above, then open it and follow the following steps

1. Go to file-> open and go to the location of the purchased "SchoolBusDriver" folder
2. In the left pane, open gradle-wrapper.properties file
3. Make sure that you set the gradle version to 4.10 in the last line of the file

distributionUrl=https\://services.gradle.org/distributions/gradle-7.2-all.zip

4. In the left pane, open "Util.java" file
5. Change the value for the variable "WEB_SERVER_URL" with your backend url
6. Edit the "AndroidManifest.xml" file to add your Google maps api key

	#change the value with your api key
        <meta-data
            android:name="com.google.android.geo.API_KEY"
            android:value="YOUR GOOGLE MAPS API KEY HERE" />

7. Do the same steps as above in parent app for mapbox setup (you can use the same key)

---

D) Firebase setup - top

Go to your fire base account

Add new project and name it "SBurK", if you do not perform this step when you install the backend

Click on the Android icon to add Firebase to your Android app

Do the following for both android apps

• Fill out the app information in the displayed form
  • Package name is the applicationId in your app-level build.gradle file.
  
  Note that, the applicationId is located in build.gradle file as shown in the following image.
  
• Click on "Register app"
• Click on "Download google-services.json"

• Save the downloaded "google-services.json" file in the path "SchoolBusTracker/app" (parent app) or "SchoolBusDriver/app" (driver app). Each of the parent and the driver apps will have a separate google-services.json configured with the specific package name of each app.
• Goto Authentication from the sidebar and click "Get started"
• Click phone

• Enable it

• To submit the apps for Google play, you need to add some test numbers as shown in the above image. Submit these instructions with the apps so Google reviewers can test the apps. More info here
• For SMS Authentication to work you need to register your SHA-1 key in firebase
1. Run the following command in your terminal. Change the "your-key-alias-name" with the alias you wrote when you have created the key file. Also, change "path-to-production-keystore" to the path of your key file on the hard disk.
Production:

keytool -list -v -alias "your-key-alias-name" -keystore "path-to-production-keystore"
				

Debug:

keytool -list -v -alias androiddebugkey -keystore ~/.android/debug.keystore
				

(Default password is empty)
2. Open the project settings from firebase and add the SHA-1 key for each app

---

E) Ad setup - top

Set app id in AndroidManifest.xml

Set app unit id in activity_main.xml

---

F) FAQ - top

1. How to change the share message of the driver and parent apps?

Edit the string.xml file in the path "app/src/main/res/values" at the tag

		<string name="share_body">

You can also edit it in other languages in the folders values-lang, where lang in {"de", "fr", ..}
2. Notifications not working

Make sure that you installed the "google-services.json" file in the path "SchoolBusTracker/app"

In Android studio, click on file->Invalidate Caches / Restart, then clean project and rebuild it.

3. The school bus icon is not moving while the driver changes his location

Make sure that the laravel-echo-server is working correctly. Go to the url of your admin panel and append it with 6001, i.e., open http://www.yourdomain.com:6001 and check if it gives OK

4. The parent app or driver app does not continue after entering the correct verification code

Make sure that you install the Firebase cloud messaging correctly by adding "google-services.json" file. The app needs a token from the Firebase and will not continue to the main screen until this token is obtained.

---

Once again, thank you so much for using SBurK. As I said at the beginning, I'd be glad to help you if you have any questions. I'll do my best to assist. If you have a more general question relating to the items on CodeCanyon, you might consider visiting the forums and asking your question in the "Item Discussion" section.

CreativeAppsDev Team

Go To Table of Contents

---