Go Ride Documentation

Web Documentation#

Please follow the steps mentioned on the left side bar for easy setup

Introduction

The online cab booking service providers care the price of traveling based on the
distance of travel trip and type of car, traffic, and waiting prices. There are
numerous apps available in the android play store and apple app store for cab
booking in India.

Selecting the greatest taxi booking apps in India is tough, which may vary from
town to town.

Basic Installation#

Basic knowledge required to setup

  • ★ Real server Server related knowledge like apache or local machine server, we preferred to use a real server
  • ★ Server related knowledge and we preferred cPanel in your server for quick installation
  • ★ Basic knowledge in PHP, Laravel and Flutter if you want to do some
    customization yourself (Not compulsory).
  • ★ Basic knowledge about google cloud and firebase

Server Requirement#

Laravel 10.x requires a minimum PHP version of 8.1
Support for MySQL v5.7
Apache Server (Recommended)
Mod_rewrite Apache
PDO Extension and other required modules of PHP
Firebase Account
Firebase Database
Google MAP API Key

Admin Panel Setup#

How to set up Go Ride admin panel on your server?

Step 1:

After downloading the source code unzip goride_source_code.zip and upload the goride_admin_panel.zip file and extract to the root directory of your server.

For example: /var/www/html/ or /home/yourusername/public_html or whatever is the root folder of your domain or subdomain. Which will make it reachable as follows: http://yourwebsitename/

Step 2:

Create a new database from your server MYSQL database

Step 3:

Create a DB user to the database and link that database to the DB user

Note:

Give all permission to your user by Check on “All PRIVILEGES”

Step 4:

Update your database credentials (DB_DATABASE, DB_USERNAME&DB_PASSWORD) to.env file which exist at root path of admin panel

Step 5:

Click on the Import Database button and import the admin database goride_admin_database.sql file.

Step 6:

Update your APP_NAME & APP_URL In .env file

Now you can access your admin panel with your desired domain.

Login with default admin credentials

Username: admin@goride.com
Password: 12345678

Google Map API Key#

How to Create Google Map API Key?

1. Go to the Google Maps Platform

2. Click the Get Started button in the middle of the screen.

3. Click on the Google Cloud Platform home in the upper left corner.

4. Click on Billing to make sure your billing details are up-to-date. If they are not, your Google Maps will not work properly.

5. Once you’ve confirmed your billing is up-to-date, click on the Google Cloud
Platform home in the upper left corner again.

6. Hover to APIs & Services and go to Credentials.

7. If you want to use an existing project, please select it from the list. Otherwise, select ‘Create a new project’ and enter a project name.

8. Click Create credentials and select API key. You will see a new dialog that
displays the newly created API key.

9. Click the Close button in the API key dialogue. Your new API key will be listed on the Credentials page under API keys

Admin Panel - Update#

How to Admin Panel - Update?

To update the admin panel just upload our latest source code zip file in your project root folder and extract it.

If you customized something on the code and want to update to our latest version then you can follow any one option from following this.

  • 1. First push your code on a git branch then download our latest version source code from codecanyon and push it to another branch. And then you can merge the changes between current version and previous version code and merge both branches and it is possible to get conflicts on branches.
  • 2. Download the our latest version source code from codecanyon and apply.

Firebase Project Setup#

How to set up Firebase Project Setup/Configuration?

Step 1:

Go to the firebase console using this link

https://firebase.google.com/

Step 2:

Click on “Go to console” in the top right corner.

Step 3:

Click on “Add project”, it will redirect you to the new project creation page Enter your project name and click on “Continue” again click on “Continue” after that select “Default Account fo firebase” and then click on “Create Project”

Step 4:

After creating a new project it will redirect you to the overview page on this page click on icons like

It will redirect you to the “Add Firebase to your web app” page enter your app nickname and click on “Register app” after clicking on it scroll down you can see details like below

You can add these firebase project details in the project’s .env file.

Step 5:

Create a RealTime database and copy url and add into project’s .env file.

Step 6:

After that click on “Firestore Database” in the left sidebar and select your project name from the drop-down and click on “Create database”

Step 7:

Select the preferable option for you and click on the Next button then click on “Enable”.

Step 8:

Firstore Database Rules Update.

Step 9:

Enable Firebase Authentication Methods

To enable Firebase Authentication, go to Firebase Console -> Authentication -> Sign-in Methods and enable the methods that you are going to support in your app. By default, our Flutter apps have integration with Phone, Google and Apple.

See video for more

video

Firestore Database#

Firestore Database Collection Import/Export

Step 1:

Setup NPM in your Computer URL

https://nodejs.org/en/download

Step 2:

Extract Source Code of firbase-import-export-functions.zip

Step 3:

We have to open command prompt on project folder and run command : “npm install”

Step 4:

Setup Firebase Project if you have not created.

Step 5:

Configure serviceAccountKey.json file. you can get from forbase Project settings

Go to ->Service account -> Select Node.js -> Generate new private key Wait untill create key this will auto download. and Replace with current serviceAccountKey.json

Step 6:

Run command on project folder bellow import commands All Collections are in Folder name “GoRideDataSeed” One By one You have to run command for import each collection

See video for more

video

Firestore Database Collection Import/Export

node import.js GoRideDataSeed/banner.json
node import.js GoRideDataSeed/cms_pages.json
node import.js GoRideDataSeed/coupon.json
node import.js GoRideDataSeed/currency.json
node import.js GoRideDataSeed/documents.json
node import.js GoRideDataSeed/driver_rules.json
node import.js GoRideDataSeed/faq.json
node import.js GoRideDataSeed/languages.json
node import.js GoRideDataSeed/on_boarding.json
node import.js GoRideDataSeed/service.json
node import.js GoRideDataSeed/settings.json
node import.js GoRideDataSeed/tax.json
node import.js GoRideDataSeed/vehicle_type.json

Note:

#Not compulsory to run this commands for import collections

node import.js GoRideDataSeed/bank_details.json
node import.js GoRideDataSeed/driver_document.json
node import.js GoRideDataSeed/driver_users.json
node import.js GoRideDataSeed/intercity_service.json
node import.js GoRideDataSeed/orders.json
node import.js GoRideDataSeed/orders_intercity.json
node import.js GoRideDataSeed/referral.json
node import.js GoRideDataSeed/review_customer.json
node import.js GoRideDataSeed/review_driver.json
node import.js GoRideDataSeed/users.json
node import.js GoRideDataSeed/wallet_transaction.json
node import.js GoRideDataSeed/withdrawal_history.json

#Export collections commands

node export.js bank_details
node export.js banner
node export.js cms_pages
node export.js coupon
node export.js currency
node export.js documents
node export.js driver_document
node export.js driver_rules
node export.js driver_users
node export.js faq
node export.js intercity_service
node export.js languages
node export.js on_boarding
node export.js orders
node export.js orders_intercity
node export.js referral
node export.js review_customer
node export.js review_driver
node export.js service
node export.js settings
node export.js tax
node export.js users
node export.js vehicle_type
node export.js wallet_transaction
node export.js withdrawal_history</blockquote>

Query Indexing

While viewing the admin panel if you see a processing loader then please open your browser console and check the errors. If the errors showing below snap then click on the given URL to do indexing. And it will create index in firebase automatically and errors will be removed from the page.

Deploy Firebase#

Deploy Firebase Functions

Important Notes:

To deploy Firebase Functions, you need to make sure you upgrade your Firebase Pricing Plan to Blaze.

Step 1:

Setting up Node.js and the Firebase CLI

Use the Firebase doc (https:// rebase.google.com/docs/functions/get-started) if
you encounter any issues.

Node.js and Firebase CLI is needed to write functions and deploy them to the
Cloud Functions.

Install Node.js (https://nodejs.org/en/) and npm (https://www.npmjs.com/), Node
Version Manager (https://github.com/nvmsh/nvm/blob/master/README.md).

After Node.js and npm are installed, install the Firebase CLI.
Use: “npm install -g firebase-tools” command.

Step 2:

Initialize your project

An empty project containing sample code is created when you initialize Firebase
SDK for cloud functions.

Authenticate the firebase tool by running the firebase login via browser You need to create a new “MyFirebaseFunctions” empty folder

Go to the source code and find firebase-cloud-functions.zip file and extract it and go to firebase-cloud-functions > functions folder add your firebase credentials in serviceAccountKey.json, index and .firebaserc file.

Step 3:

Deploy Firebase Functions

Open powerShell from firebase-cloud-functions > functions and run command

“npm install”

“firebase login” (Select Y(yes) and It will redirect to browser and login with
google account which you used for firebase)

Now after successfully login simply run this command

“firebase deploy –only functions”

And it deploy your firebase cloud function and you can also check status in CLI

After successfully deploying the functions you can go to your Firebase Console
and check, as the functions have been deployed.

Step 4:

Watch Firebase Functions for Errors

It is possible to see the logs for each function, understand the output, and know when it gets called.

Important Notes:

To run properly, some firebase functions need the creation of indexes on
certain firestore collections.

Use the app and watch the logs for the firebase functions in the console.

If you happen to get an error of missing index, simply click on the URL of that
error, and the index will get created automatically.

There is no need to deploy functions again, but wait until the index is created, before testing the app again.

See video for more

video

Create Google Map API Key

1. Go to the Google Maps Platform

2. Click the Get Started button in the middle of the screen.

3. Click on the Google Cloud Platform home in the upper left corner.

4. Click on Billing to make sure your billing details are up-to-date. If they are not, your Google Maps will not work properly.

5. Once you’ve confirmed your billing is up-to-date, click on the Google Cloud
Platform home in the upper left corner again.

6. Hover to APIs & Services and go to Credentials.

7. If you want to use an existing project, please select it from the list. Otherwise, select ‘Create a new project’ and enter a project name.

8. Click Create credentials and select API key. You will see a new dialog that
displays the newly created API key.

9. Click the Close button in the API key dialogue. Your new API key will be listed on the Credentials page under API keys

Application Setup#

How to set up the project

Change App Name (For both application customer and driver follow same step)

1. Change the value of label from

/android/app/src/main/AndroidManifest.xml

2. Change the value of CFBundleName from (For both application customer and driver follow same step)

/iOS/Runner/info.plist

Change App Package (For both application customer and driver follow same step)

First you have to find out the existing package name. You can find it out from the top of the /app/src/main/AndroidManifest.xml file. Now on the right side of the project folder from VSCode. In the first box you have to put the existing package name that you saw in the AndroidManifest.xml file previously and write down your preferred package name in the second box and then click on Replace All button.

Replace Map key#

1. Android

/android/app/src/main/AndroidManifest.xml

2. IOS

/ios/Runner/AppDelegate.swift

Firebase Setup#

How to Application Setup with firebase ?

1. Setup with firebase using flutterFire.

/android/app/src/main/AndroidManifest.xml

a. Follow this link to setup with firebase :-

https://firebase.google.com/docs/flutter/setup?platform=ios

video

2. Setup manually.

a. For Android

b. Enter package name

c. Download google-services.json file.

d. Place google-services.json file in /project/android/app/

For IOS

1. Add App

2. Enter package name and download GoogleService-Info.plist

3. Place GoogleService-Info.plist in /iOS/

Generate SHA-1 for Flutter#

Link :-

https://stackoverflow.com/questions/51845559/generate-sha-1-for-flutter-react-native-android-native-app

App build & release

1. Build for Android

For debug build you can run command:

flutter build apk

You will get a larger merged apk with this. But you can split them with this
command:

flutter build apk –target-platform android-arm,android-arm64,android-x64
–split-per-abi

Build file location: /build/app/outputs/flutter-apk/ For deploying it
please follow this documentation:

https://docs.flutter.dev/deployment/android

2. Build for iOS

There is no general way to generate apps for iOS. Apple doesn’t allow you to install apps like this. If you want to install it on your iOS device then you have to deploy it on TestFlight or AppStore. For deploying it please follow this documentation:

https://docs.flutter.dev/deployment/ios

video

Landing page setup#

Step 1:

After downloading the source code unzip goride_source_code.zip and upload the goride_landing_panel.zip file and extract to the root directory of your server.

Like: http://landing.yourdomain.com/ or whatever which you like.
Please use subdomain of your main domain for landing page setup (Recommended)

Step 2:

Update firebase credentials at .env file of landing page site.

Important Notes:

Please use this same firebase credentials for landing page setup which you will add for admin panel setup on .env file.

Now you can access your landing page at your desired domain

For ex: http://landing.yourdomain.com/