“SBurK” Documentation v1.3


“iOS Apps for Parents and Drivers”

Table of Contents

  1. What is SBurK?
  2. Driver App
  3. Parent App
  4. In app purchases setup
  5. FAQ

A) What is SBurK? - top

SBurK is a comprehensive system for school bus tracking that manages the daily school bus operation. SBurK comes in two packages: basic and extended. The basic package consists of three sub systems, which are

The extended package has the contents of the basic one plus the following

Here we present the iOS mobile apps for parents and drivers

Please setup the backend first, then the mobile apps.


B) Driver App - top

In order to build the iOS app for drivers correctly, please make sure that

Follow the following steps

  1. Open a new terminal
  2. Go to the location of the purchased "SchoolBusDriver" folder
                cd /to/location/of/SchoolBusDriver/folder
            
  3. write
                pod install
            
  4. Find the generated "SchoolBusDriver.xcworkspace" file and open it with XCode 12.4
  5. In the left pane, select the project "SchoolBusDriver"
  6. Under Signing & Capabilities sign in with your Apple ID
  7. Sign in
  8. In the left pane, open "Util.swift" file
  9. Change the value for the variable "WEB_SERVER_URL" with your backend url
  10. Change the value for the variable "GOOGLE_MAPS_API_KEY" with your Google maps api key
  11. Edit Util.swift file
  12. Optional: Change the default country code of driver telephone number by changing the line #36 in LoginViewController.swift file
  13.             phoneNumberTextField.setFlag(key: .US)
            
  14. Optional: If your web server is not secure, i.e., http not https, then you need to write the follwing in your info.plist and change "WEB_SERVER_URL"
  15.             <key>NSAppTransportSecurity</key>
                <dict>
                    <key>NSAllowsArbitraryLoads</key>
                    <true/>
                    <key>NSExceptionDomains</key>
                    <dict>
                        <key>WEB_SERVER_URL</key>
                        <dict>
                            <key>NSExceptionAllowsInsecureHTTPLoads</key>
                            <true/>
                            <key>NSIncludesSubdomains</key>
                            <true/>
                        </dict>
                    </dict>
                </dict>
            
  16. Build the workspace
  17. Build workspace

C) Parent App - top

In order to build the iOS app for parents correctly, please make sure that

Follow the following steps

  1. Open a new terminal
  2. Go to the location of the purchased "SchoolBusTracker" folder
    cd /to/location/of/SchoolBusTracker/folder
    
  3. write
    pod install
    
  4. Find the generated "SchoolBusTracker.xcworkspace" file and open it with XCode 12.4
  5. In the left pane, select the project "SchoolBusTracker"
  6. Under Signing & Capabilities sign in with your Apple ID
  7. Sign in
  8. In the left pane, open "Util.swift" file
  9. Change the value for the variable "WEB_SERVER_URL" with your backend url
  10. Change the value for the variable "WEB_SOCKET_SERVER_HOST" with your laravel-echo-server url
  11. Change the value for the variable "WEB_SOCKET_SERVER_PORT" with your laravel-echo-server port number
  12. Change the value for the variable "GOOGLE_MAPS_API_KEY" with your Google maps api key
  13. Please follow the steps here to configure the push notifications correctly.
  14. Edit Util.swift file
  15. Go to your fire base account
  16. Add new project and name it "SBurK", if you do not perform this step when you install the backend
  17. Firebase cloud messaging
  18. Click on the iOS icon to add Firebase to your iOS app
  19. Firebase cloud messaging
  20. Fill out the app information in the displayed form Firebase cloud messaging
      Note that, iOS Bundle ID is the bundle identifier in your Xcode project as shown in the following image.
      Firebase cloud messaging
  21. Click on "Register app"
  22. Click on "Download GoogleService-Info.plist" and save it inside the folder "SchoolBusTracker
  23. Right click on the SchoolBusTracker Folder in the left pane of Xcode, and choose add files to SchoolBusTracker. Then choose "GoogleService-Info.plist" file.
  24. Optional: Change the default country code of driver telephone number by changing the line #36 in LoginViewController.swift file
  25.             phoneNumberTextField.setFlag(key: .US)
            
  26. Optional: If your web server is not secure, i.e., http not https, then you need to write the follwing in your info.plist and change "WEB_SERVER_URL"
  27.             <key>NSAppTransportSecurity</key>
                <dict>
                    <key>NSAllowsArbitraryLoads</key>
                    <true/>
                    <key>NSExceptionDomains</key>
                    <dict>
                        <key>WEB_SERVER_URL</key>
                        <dict>
                            <key>NSExceptionAllowsInsecureHTTPLoads</key>
                            <true/>
                            <key>NSIncludesSubdomains</key>
                            <true/>
                        </dict>
                    </dict>
                </dict>
            
  28. Build the workspace

D) In app purchases setup - top


E) FAQ - top

  1. Which versions of iOS both the driver and parent apps works with?
  2. The driver and parent apps works with iOS version 10.0 or greater

  3. How to change the share message of the driver and parent apps?
  4. Edit the strings file in the path "AppStrings/en.lproj/Localizable.strings" at the tag

        "share_body" = "your share message";
    
    You can also edit it in other languages in the folders lang.lproj, where lang in {"de", "fr", ..}

  5. Notifications not working
  6. Make sure that you installed the "GoogleService-Info.plist" file in the path "SchoolBusTracker"

  7. The school bus icon is not moving while the driver changes his location
  8. 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

  9. The parent app does not continue after entering the correct verification code
  10. Make sure that you install the Firebase cloud messaging correctly by adding "GoogleService-Info.plist" 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