πŸ› οΈGetting Setup

Step by Step Guide to Setup the Project in Android Studio.

Step1: Creating your Google Developers Account (Paid) [Pre-Requisites]

You can create a google developers Account from below URL. https://play.google.com/apps/publish/signup/

To Learn How to Register Check below Link. https://support.google.com/googleplay/android-developer/answer/6112435?hl=en

Step 2: Updating Package Name

Before creating project in Firebase console, you first need to update the Package Name β€œcom.hyvikk.thefleet.vendors”.

It is Required to Change else you want be able to Publish Fleet MultiBranch App to Playstore.

To know how to Update it check Below link. https://stackoverflow.com/questions/16804093/rename-package-in-android-studio

Note: if you want to publish your app to Google Playstore, you must update the package name. Google Playstore won’t accept Apps with same package name.

Step 3: Adding Firebase to Project/App.

To do this Just Follow Steps as mentioned in Below Webpage. https://www.geeksforgeeks.org/adding-firebase-to-android-app/

Notes:

a. You must be logged in to the Respective gmail account through which you have created Google Developers Account.

b. Replace the old β€œgoogle-services.json” with the file Automatically created in Firebase Console while Creating Project.

c. You don’t need to add "firebase sdk" as it is already there within the project. Just skip that step and Go to Next Step.

Step 4: Connecting To Firebase β€œRealtime Database”.

Important Note : You Must have Purchased & Configured Fleet Manager Android App

Step 5: Updating BASE URL for APIs (APIClient.java) from Project Code.

This will Connect your App To "Fleet Manager Web Admin".

  • Find this file at below mentioned path from the Project Code.

    • β€œ FleetVendors/app/src/main/java/com/hyvikk/thefleet/vendors/API/APIClient.java ”

  • Find Vendor API Module from your β€œFleet Manager Web Admin” Setup.

  • Set Vendor API URL in "BASE_URL".

Step 6: Updating ABOUT Screen URLs (strings.xml) from Project Code.

To Update Company Page URLs Like Terms & Conditions and Privacy Policy.

Find this file at below mentioned path from the Project Code.

β€œFleetVendors/app/src/main/res/values/strings.xml”

  • TC_URL : This String is used to Add Terms & Conditions Page Link in Mobile App.

    • It is Recommended to set it for the Consumer’s Point of view. Write Terms & Conditions as per your Company policy and Create a Webpage for it. After that Set that URL in β€œTC_URL”.

  • PRIVACYPOLICY_URL : This String is used to Add Privacy Policy Page Link in Mobile App.

    • It is recommended to set it for the Consumer’s Point of view. Write Privacy Policy Terms as per your Company policy and Create a Webpage for it. After that Set that URL in β€œPRIVACYPOLICY_URL”.

  • FACEBOOK_URL : Facebook Page URL of your App/Company.

  • TWITTER_URL : Twitter Page URL of your App/Company.

  • INSTAGRAM_URL : Instagram Page URL of your App/Company.

Step 7: Creating Google API key for the App.

To Create API Key for your App Project Follow Steps Mentioned in Below URL.

https://support.google.com/googleapi/answer/6158862?hl=en

Step 8: Enabling APIS for the Project [Required].

APIS will help you run "Fleet MultiBranch App" Properly. It is Mandatory to Enable it from Google > API Library.

To Enable APIs; Follow Below Mentioned Steps.

  • Go to the API Console.

  • From the Projects list, select β€œFleet MultiBranch App” project or create a new one.

  • Open "APIs & services" Page from the Navigation Menu[Left Side].

  • Click on "Library", To Open Complete "API Library" Collection.

  • Search for Below Mentioned APIs Using "Search Box" and Enable it.

    • Places API

    • Identity Toolkit API

    • Maps SDK for Android

  • DONE ! You have ENABLED Required APIs.πŸŽ‰

Step 9: Enabling Billing for the Project APIs on Google Developers Console

To Increase the APIs Usage Limit, you must add billing Account for your Project.

Follow Steps mentioned in below URL to Enable Billing.

https://support.google.com/googleapi/answer/6158867?hl=en&ref_topic=7013279

Google has Free Usage Limits for "Places & Maps Related APIs". To Smoothly Run the App; It is Required to Add/Enable Billing for the "Fleet Vendors App" Project on Google Developers Console.

Step 10: Updating Firebase Realtime Database & Access Keys (strings.xml) From Project Code.

Firebase Realtime Database will be used to Access Driver's Location Data of "Fleet Manager App".

  • Find this file at below mentioned path from Project Code.

    • β€œ FleetVendors/app/src/main/res/values/strings.xml ”

  • Update Values of Below Mentioned Variables.

    • firebase_database_url : This URL is used to Connect and Access Driver's Location Data for Tracking Feature. The Location's data which will be Accessed are of Driver Users from "Fleet Manager App".

      1. Copy "Database URL" As Mentioned in STEP 4.

      2. You can Find it from "Realtime Database > Data Tab".

      3. Set the Copied URL.

    • firebase_application_id : To Connect App with Firebase Project of Fleet Manager Mobile App.

      1. Find β€œApplication_id / Project ID” from "Firebase Project > Project Settings > General Tab".

      2. Copy "Application id".

      3. Set it in Above Variable.

    • firebase_api_key : To Connect & Access Database of Fleet Manager Mobile App from Fleet Vendors App.

      1. Find the β€œAPI Key / Web API Key” from "Firebase Project > Project Settings > General Tab".

      2. Copy "API Key".

      3. Set it in Above Variable.

Step 11: Updating Google Maps API key (google_maps_api.xml) from Project Code.[Important]

Google Maps API Key will be Used for "Google Place Search" in "Add Booking" Feature.

  • Find this file at below mentioned path from Project Code.

    • β€œ FleetVendors/app/src/main/res/values/google_maps_api.xml ”

  • Copy the β€œAPI-KEY” that you have generated in Step-7.

  • About Variables.

    • google_maps_key : To Search Place OR Location for Pickup & Dropoff Addresses in β€œAdd Booking Feature” of β€œFleet MultiBranch App”.

  • Set Copied "API-KEY" in Above Variable.

Complete 🎯

You have successfully Configured Google Firebase and Google Developers Console for β€œFleet MultiBranch App”.

Now, Your β€œFleet MultiBranch App” is fully prepared to shine! ✨

⚑⚑Enjoy its powerful features & functionalities.⚑⚑

Last updated