Introduction

This documentation will give you an understanding of how Jobbers is structured and guide you in performing the most common functions. If you require further assistance, related to topics not covered in this documentation, then please contact us via Our Support Forum.

NOTE: We will not respond to any support questions on Item comment section or through e-mail. If this document doesn’t answer your questions feel free to open up a private ticket in our our support forum

If you want to customize iOS and Android Application as per your requirement, please contact us here: Our Support Forum

Installation

Let’s start the installation process with Getting Started

Android App Package

– Car-Dealer-Android.zip

– Car-Dealer-Android.zip (Contains Android Code)
– Car-Dealer-Android-Documentation.zip (Contains Android Documentation)
– pgs-cardealer-api-installer-1.0.0.zip (Contains Plugin for web-service)

iOS App Package

– Car-Dealer-iOS.zip

– Car-Dealer-iOS.zip (Contains iOS Code)
– Car-Dealer-iOS-Documentation.zip (Contains iOS Documentation)
– pgs-cardealer-api-installer-1.0.0.zip (Contains Plugin for webservice)

Getting Started

Getting Started with pgs-cardealer-api Plugin.
This application only works with the Car Dealer theme.

* PHP version 5.6 or greater (PHP 5.6 or greater is recommended)
* MySQL version 5.0 or greater (MySQL 5.6 or greater is recommended)
* PGS CarDealer Api 1.0 requires WordPress 4.4+
* CarDealer Theme 3.0.0 or greater

API Plugin Installation

Cardelear is Native Android and iOS application specially developed for CarDelear website. The Cardelear application is the high configurable application in which admin can change theme, banner and many other options. Cardelear Android and iOS application can easily configure in simple single step. This Document walks you through how to set Cardelear API Plugin.

Once you are done with The Car Dealer API Plugin, you can setup The Car Dealer Android and iOS Application. Check the Android Application Configuration and iOS Application Configuration to set the Application.

Follow below video to install The Car Dealer API Plugin.

For Android applicatioin configuration Click here.

For iOS applicatioin configuration Click here.

Android Application Configuration

Follow below video to setup The Car Dealer Android Application.

How to open Android Project code in Android Studio.
There is two way to open your android project in Android Studio.
1. Open Android Studio and click on Import project, and choose Cardelear project. If you are opening any project first time in android studio.

OR

2. Open Android Studio and go to File -> New -> Import Project, select CarDelear Project.

NOTE:- Sometimes android studio gives an error due to the long project path, so we recommend you to copy your code to a short path in any drive Ex: D:/MainFolder/CarDelear.

Setup Store URLs.

A) Open your CarDealer website admin panel. And Login to your admin panel.

B) Hover on CarDealer tab there is an option Theme Options, click on Theme Options button.

C) Your CarDealer theme admin is having an option as App Settings.

D) In App Settings tab click on Credentials Code.

E) Click on Apple icon, here you will get code for Android application. Now Click on Copy button. So the Code for URL and other detail will be copied.

Note: URL for your CarDealer site must have "/" added at the end, and it must not contains any other page path at the end as shown in the Image.

F) Open Project in Android Studio. And Open ..\\Api\HttpParams.java file and replace code copied from PGS Woo Plugin with code in HttpParams.java file.

Now your CarDealer Android application is ready to run.

iOS Application Configuration

Single step setup for CarDealer iOS Application.

Follow below video to setup The Car Dealer iOS Application.

Setup Store URLs.

A) Open your CarDealer website admin panel. And Login to your admin panel.

B) Hover on CarDealer tab there is an option Theme Options, click on Theme Options button.

C) Your CarDealer theme admin is having an option as App Settings.

D) In App Settings tab click on Credentials Code.

E) Click on Apple icon, here you will get code for iOS application. Now Click on Copy button. So the Code for URL and other detail will be copied.

F) Open the CarDealer Application in Xcode, and open GlobalConstant.swift file. Here find struct URLs as shown in the Image.

G) Paste the code copied from the Credential code here as Shown in the Image.

Now your CarDealer iOS application is ready to run.

Other Android Application Configuration steps

Android Customization

  • Change app name:
    • Open app/src/main/res/values/strings.xml file and find those items.
    • Modify the value of app_name “CarDelear” by your preferred name.
    • <string name="app_name">Your app name</string>
  • Change app theme color :
    • Open app/src/main/res/values/colors.xml
    • <color name="colorPrimary">#009688</color>
    • <color name="colorPrimaryDark">#D50000</color>
    • <color name="colorAccent">#E6000000</color>

  •  Change app icon:
    • Open app/src/main/res/mipmap/ic_launcher icon.
    • Replace the ic_launcher.png  by your icon.

 
Follow below video for changing the application icon of The Car Dealer Android Application

 

  • Change splash icon:
    • Open app/src/main/res/drawable/  icon.
    • Replace the logo.png  by your icon.

 

  • Change splash copyright text:
    • Modify the value of copyrights “© COPYRIGHT 2019 | ALL RIGHTS RESERVED” by your preferred name.
    • <string name="copyrights">© COPYRIGHT 2019 | ALL RIGHTS RESERVED</string>

 

  • Change package name:
    • Follow this instruction to change your package name:

 
Follow below video for the Package name change in The Car Dealer Android Application.

 

For example, if you want to change com.example.app to my.awesome.game, then:

  1. In your Project pane, click on the little gear icon ( Gears icon )
  2. Uncheck / De-select the Compact Empty Middle Packages option

3.Your package directory will now be broken up in individual directories

4.Individually select each directory you want to rename, and:

  • Right-click it
  • Select Refactor
  • Click on Rename
  • In the Pop-up dialog, click on Rename Package instead of Rename Directory
  • Enter the new name and hit Refactor
  • Click Do Refactor in the bottom
  • Allow a minute to let Android Studio update all changes
  • Note: When renaming com in Android Studio, it might give a warning. In such case, selectRename All

5. Now open your Gradle Build File (build.gradle – Usually app or mobile). Update the applicationId in the defaultConfig to your new Package Name and Sync Gradle, if it hasn’t already been updated automatically:

6. You may need to change the package= attribute in your manifest.

7. Clean and Rebuild.

8. Done! Anyway, Android Studio needs to make this process a little simpler.

Add Language

Follow below video for adding language in Android application.

 

Android Localization Language ISO Codes

Below table give you ISO languages codes for all the languages that android supports.

Language Locale values/strings.xml
German de values-de/strings.xml
Chinese zh values-zh/strings.xml
Czech cs values-cs/strings.xml
Dutch nl values-nl/strings.xml
French fr values-fr/strings.xml
Italian it values-it/strings.xml
Japanese ja values-ja/strings.xml
Korean ko values-ko/strings.xml
Polish pl values-pl/strings.xml
Russian ru values-ru/strings.xml
Spanish es values-es/strings.xml
Arabic ar values-ar/strings.xml
Bulgarian bg values-bg/strings.xml
Catalan ca values-ca/strings.xml
Croatian hr values-hr/strings.xml
Danish da values-da/strings.xml
Finnish fi values-fi/strings.xml
Greek el values-el/strings.xml
Hebrew iw values-iw/strings.xml
Hindi hi values-hi/strings.xml
Hungarian hu values-hu/strings.xml
Indonesian in values-in/strings.xml
Latvian lv values-lv/strings.xml
Lithuanian lt values-lt/strings.xml
Norwegian nb values-nb/strings.xml
Portuguese pt values-pt/strings.xml
Romanian ro values-ro/strings.xml
Serbian sr values-sr/strings.xml
Slovak sk values-sk/strings.xml
Slovenian sl values-sl/strings.xml
Swedish sv values-sv/strings.xml
Tagalog tl values-tl/strings.xml
Thai th values-th/strings.xml
Turkish tr values-tr/strings.xml
Ukrainian uk values-uk/strings.xml
Vietnamese vi values-vi/strings.xml


Source: 
http://bit.ly/1qYfHDL

Source and Credits

Source and Credits

butterknife => used for bind the all xml view

CircleImageView => used for circle imageview

glide => used for Load image from server

android-google-play-services-auth => used for location

Gson => used for convert Java Objects into their JSON representation

Retrofit => used for HTTP client for Android Api calling

Firebase Dynamic Links on Android => used for deeplink android

Other iOS Application Configuration steps

Change App Name

To Change app name follow below steps:

  • Open Car Dealer iOS Application in Xcode.
  • Change Display Name to your desired app name.
  • Open GlobalConstants.swift file and search for AppName and change AppName to your desired application name.

Change App Icon

Follow below video to change icon of the Car Dealer iOS Application.

 
To Change App Icon follow below steps:

  • Take 1536*1536 image for the icon.
  • Go to https://makeappicon.com/ and click on Choose File and upload your app icon, it takes few minutes to make icons.
  • After that, it asks for your email address to download icons, enter the email address and click on send button next to it.
  • Your app icons will send to your email address, open your email address, download app icons.
  • Go to your download folder and extract that folder.
  • After extract folder open AppIcon folder, in that open ios folder, copy AppIcon.appiconset.
  • Open CarDealer project in Xcode. Open ImageAssets, right click on AppIcon.xcassets, and choose Show in Finder.
  • Now copy the downloaded folder AppIcon.appiconset and replace it with the folder inside folder AppIcon.xcassets.
  • Now the app icons are replaced with the icon that you want.

Change SplashScreen

Change Splash screen:

  • Open Car Dealer iOS Application in Xcode.
  • Open ImageAssets folder. Now Open Splash.xcassets, here logoCarDealer image is available change image with the splash icon that you want.
  • Now open LaunchScreen.storyboard here there is label at the bottom of the screen, change that label to the desired copyright text.
  • NOTE: It must be the same size as existing Splash Image.

Add Language

Follow below video to add language in the Car Dealer iOS Application.

 
To add language to the CarDealer iOS application follow below steps;

  • Open the CarDealaer iOS application in Xcode.
  • Now open Languages folder in ../CarDealerApp/HelperClasses/. Here all the languages are available that are already in the CarDealer iOS application.
  • Right click on en.json file and click on Show in Finder button.
  • Copy en.json file.
  • Paste file on any location on your system.
  • Change file name from en to any langauage that you want, as shown in the image below.
  • Now drag and drop the file with changed name to the Language folder, then one popup is shown as shown in the image. Click on Finish button.
    Note: Make sure that Copy item if needed is marked as well as Create groups in Added folder option. and Add to targets must be marked.
  • Now the file is added to the folder Language. Open the file you have added to the Xcode.
  • Change each and every value with the language that you want to add. Suppose you want to add Chinese to the CarDealer App then change all the values with the Chinese equevelent words, as shown in the Image below.
  • Now open AppDelegate.swift file and search for setLanguageData() method.
  • Copy code MCLocalization.sharedInstance.addProvider(MCLocalization.JSONProvider(language: "en", fileName: "en.json")) and paste it below the last line, as shown in image.
  • Change file name with the file name that we have added to the CarDealer App.
  • Open https://make.wordpress.org/polyglots/teams/ link. Here all the codes which are preferred by WordPress is listed.
  • Select language that you want to add in your App. For example we are adding Chinese language so select chinese WP Locale language code and copy language code for chinese language i.e “zh_CN”.
  • Now open the CarDealer iOS app in Xcode, and open AppDelegate.swift file and go to setLanguageData() method. Now paste language code into the code that we added to add new language file in setLanguageData() method.
    Note: If the code that we have added in setLanguageData() method is having"_"(Under Score) then replace it with "-"(dash), as shown in the Image.
  • Now new language is added to the CarDealer iOS Applicaiton

Target name change

Follow below video to change the Target name of the Car Dealer iOS Application to your desired name.

Source and Credits

Alamofire => For web service call in the CarDelare
SDWebImage => Caching images locally on the device in the CarDelare
MCLocalization => Used For Language Localization in the CarDelare
AORangeSlider => For Range seek bar in filter price in the CarDelare
Lightbox => Used For Image Slider, Zooming and pinch in the CarDelare
JJFloatingActionButton => Used For Floating button on car listing page
TPKeyboardAvoiding => Used For Keyboard Management in the CarDelare

Push Notifications

For creating or enabling the Push notification in iOS, you must have Apple Developer Account. If you don’t have Apple Developer account, please follow the steps in this link to create Apple Developer Account.

Android Push-notification configurations

A) Open Firebase Console in  browser, login via your gmail account.

B) Click on Add Project option, provide project name and region and create project

C) Click on Add Firebase to You Android App, Provide Package Name, App Name and release SHA1 of your release keystore.

D) Click on Register App and Download Google-Service.json and Continue and Finish

E) Click on three dot menu of your app and open Settings, Navigate to Cloud Messaging Tab and Copy Legacy server key. See Details here:

F) Copy Legacy server key and add it to the plugin of the application store.

Ex:-Inside the Admin panel  CarDelear > Theme option > Pushnotification > add Android Legacy server key 

iOS Push-notification configurations

Register your app to receive notification:

A) Your app must be an Explicit App Id, to support Push Notification.

  1. Navigate to the Apple Developer Member Center website, and click on Certificates, Identifiers & Profiles.

2. Select an Identifier from the iOS Apps section.

  1. You will see a list of your App IDs. Click on the + button.
  1. Enter a name for your new App ID under App Id Description, choose an App ID Prefix, and under App  ID Suffix, select Explicit App ID, enter your iOS app’s Bundle ID, it should match the Bundle identifier in your Xcode project configuration and, add in the Info.plist.
  1. Enable Push Notification under App Services. Enable other services that your app will need.
  1. Click on “Continue”, check that al values entered were correct. Click on “Submit”.

B)  Now you have created the App ID; you need to configure the App ID for Push Notification.

  • Select your new App ID and click on “Edit”.

  • Scroll down to the Push Notifications section, click on “Create Certificate” under “Development SSL Certificate”.

  • Follow instructions on the next screen to create a Certificate Signing Request (CSR) using the Keychain Access utility on your Mac; this is needed to authenticate the creation of the SSL certificate.
  • Upload the CSR to Apple’s servers, and then click on “Generate”.
  • Add the certificate to your login keychain.

  • Open the Keychain Access utility. Locate the certificate under “My Certificates”. It should be called “Apple Development Push Services”. Right-click on it, select “Export” and save it as a .p12 file. Do not enter an export password when prompted!

  1. C) You will need to repeat the process to make the Production SSL Certificate.

Now we need to configure the Xcode project.

  1. Go to your project’s Capabilities page, then turn On Push Notifications. If any issues require your attention, Xcode will let you know.

to the Generate page. Modify the Bundle Identifier to match your App ID’s Bundle Identifier.

For more details documentation on Push notification click here.

Android

Follow below video for Firebase setup for Android application.

 
Follow below video for Firebase Dynamic link setup for Android application.

 
If you have not done firebase set up for the android application in firebase developer console then follow Android Firebase Setup.
Your firebase setup is already done then follow below easy steps.

A) Click on Dynamic Links tab on side menu. Then click on Get Started button.


B) Add URL Prefix and click on Continue button.
Note: Add URL of your choice. But make sure that it will have domain set as ".page.link". Else if you want to add your website URL then you need to verify it by your own.

C) Click on Finish button. Now your Dynamic URL is ready to be used.


D) Now you can add your custom URL from here. Click on New Dynamic Link button and click on Next button.

E) Need to follow below steps to enable dynamic links(deep linking) in CarDelearAndroid application;

  • Need to change PACKAGE_NAME, DeepLinkDomain, DynamicLinkIosParameter,PlaystoreMinimumVersion  in Constant.java file. Change your package neme to your desired package name, then provide DeepLinkDomain as you created in firebase, lastly if you are also having CarDelear iOS application then provide bundle identifier of your ios app. if you don’t have iOS app then keep it blank (“”). Refer screenshot to get better idea about changes as mentioned.

 

Firebase setup iOS (Dynamic Links)

The CarDealer iOS application require firebase setup to run dynamic links. So need to set up firebase project for the CarDealer iOS application.

Firebase Setup
Follow below video to setup Firebase project for the Car Dealer iOS Application.

 
Setup firebase project, and Google-Service.json file to the CarDealer iOS Application.

A) Open https://console.firebase.google.com/link in a browser. And Login to Google Firebase.

B) Click on Add Project. Enter a project name, select Country/region, accept the license agreement and click CREATE PROJECT. Firebase creates a project for you.

C) Click on continue button after project setup.

D) Now you will be redirected to your project console.

E) Click Add Firebase to your iOS app to add Firebase in your application. Enter bundle id, and nickname for the app and then click REGISTER APP. If your appstore id is available then add appstore Id else your can add it after setup.

F) Download GoogleService-Info.plist file.

G) Now GoogleService-Info.plist file is being downloaded to your download folder. Go to download folder and copy GoogleService-Info.plist file.

H) Open the CarDealer app code in finder and Paste GoogleService-Info.plist file in your project folder.

Click Next button, and then click skip button to complete the registration process in firebase console.

I) Now you can open setting of your project console and add App Store Id and Team ID from project console.

 

Dynamic link Setup

Follow below video to setup Firebase Dynamic Links for the Car Dealer iOS Application.

 

A) Open https://console.firebase.google.com/link in a browser. And Login to Google Firebase.

B) Now select on your Firebase project.

Note: Make sure that your App Store ID and Team Id is set in your firebase project.

C) Click on Dynamic Links tab on side menu. Then click on Get Started button.


D) Add URL Prefix and click on Continue button.
Note: Add URL of your choice. But make sure that it will have domain set as ".page.link". Else if you want to add your website URL then you need to verify it by your own.

E) Click on Finish button. Now your Dynamic URL is ready to be used.


F) Now you can add your custom URL from here. Click on New Dynamic Link button and click on Next button.

G) Now setup dynamic link URL that what site it is consider to redirect. Then click on Next button.

H) Set the iOS application behavior when click on Dynamic Link. Then click on Next button.
Note: If you have not added your app store id and team id if it is not added to your firebase project. Once the data is set for team id and app store id then the next button will be enabled.

I) Now set Android App behavior if you have an android app, then click on Next button.

J) Click on Create button. Now your deep link URL is ready to use. Click on Copy button to copy the Link.

K) Click on Copy button to copy the Link.

L) Open the CarDealer App in Xcode, And Open GlobalConstants.swift file in ../CarDealerApp/HelperClasses/Constants folder.

J) Now find struct Keys. In struct Keys there is DynamicLinkDomain keyword is available. Paste the copied link in DynamicLinkDomain as shown in the image.

J) Remove the detail till your domain’s “/” as shown in Image. i.e Add your domain that you have added as a Dynamic link domain while we enabled the Deep Link. Now add AppStoreId and AndroidIdentifier so that dynamic link will work properly.

So your Dynamic link is enabled for your

Google Map

Change Google Map API: You need to set your own Google Map API key. Just get create your own map api key and replace it.

  • For Google Map API Key:
  • Generate and set your api key:
      1. Go to Google Developers Console and sign in with your Google account.
      2. Create the new project (name does not matter for the plugin).
      3. Go to your project (by clicking on its name in the list).
      4. Click on the “enable apis and services” and Make sure the selected api  which are given below must be enable.

5. Get api key:  click Credentials. Then click on Create Credentials and choose Api key.

More information on Google Developers portal.

6.  Get Google map Api Key :Copy this Api key And Replace this key from your project api key values/string.xml

 

WPML Setup

Android
For WPML set up in Android Follow below video.

 
iOS
For WPML set up in iOS Follow below video.

 

Publish

Now you are all set for Mobile app submission to respected stores.

Android app submission on PlayStore

Android

For submitting the Android App to PlayStore, you must havePlayStore account. If you don’t know how to create PlayStore account, then don’t worry.This Document provides you step by step Account creation as well app submission guild line.

How to Create Google PlayStore Account?

How to submit Android app on PlayStore?

iOS app submission on AppStore

For submitting the App to Appstore, you must have Apple Developer account. If you don’t know how to create Apple Developer account, then don’t worry. Following is the very popular site for any help in iOS development or iOS App submission. This Document provides you step by step Account creation as well app submission guild line.

How to Submit An App to Apple: From No Account to App Store – Part 1
How to Submit An App to Apple: From No Account to App Store – Part 2

For video tutorial Click here.

Videos

Android

This video is showing all the features for the Car Dealer Android application with the changes in API Settings.

 
iOS
This video is showing all the features for the Car Dealer iOS application with the changes in API Settings.

 

Suggest Edit