Go Ride Documentation

To run GoRide smoothly, your server must meet the following minimum requirements:

2.1. Prerequisites

1. Web Server: Apache or NGINX
2. PHP: Version 8.0 or above
3. Database: MySQL 5.7+
4. Composer: For managing PHP dependencies
5. Domain: Specify your domain name (e.g., example.com) for the application to function properly.
6. SSL Certificate: Required for secure connections (HTTPS)
7. FTP: Used for transferring files between local and server environments.
8. Cron Job: Required for running Laravel scheduled tasks automatically.

2.2. APIs & External Services

1. Google Maps API Key for Accurate Search Result
   Required for map display, geolocation, and business search
   Enable Places, Maps JavaScript, and Geocoding APIs

3. Setup Firebase Project

3.1 : Go to firebase console through this link: https://firebase.google.com

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

3.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”

3.4 : After successfully creating a new project, you will be directed to the overview page. From there, simply navigate to the icons link to proceed further.

Upon redirection, you’ll land on the ‘Add Firebase to your web app’ page. Here, input your app’s nickname and proceed by clicking ‘Register app’. Afterward, scroll down to find detailed information as outlined below.

All of these details will be incorporated into both the app and admin panel documentation for comprehensive reference and seamless integration.

3.5 : Next, navigate to ‘Firestore Database’ in the left sidebar. Select your project name from the drop-down menu, and then proceed by clicking on ‘Create database’.

3.6 : Choose your preferred option and click on the ‘Next’ button. Subsequently, proceed by clicking on “Enable”

3.7 : Following that, locate “Realtime Database” in the left sidebar. Select your project name from the drop-down menu, and proceed by clicking on “Create Database”

3.8 : Choose your preferred option and proceed by clicking the “Next” button, then click on “Enable” to activate the selected feature.

3.9 : Firstore Database Rules Update.

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    match /currency/{doc} {
      allow read;
    }
    match /languages/{doc}  {
      allow read;
    }
    match /on_boarding/{doc}  {
      allow read;
    }
    match /cms_pages/{doc}  {
      allow read;
    }
    match /settings/{doc} {
      allow read;
    }
    match /{document=**} {
      allow read, write: if request.auth != null;
    }
  }
}

3.10. Upgrade your firebase plan.

See Video:

4. Admin Panel Setup (Laravel)

Ensure that your server meets the requirements outlined in the documentation’s Server Requirement section. Upon downloading the code, upload the admin zip file to your server and extract it. The admin panel can be installed on either a domain or a subdomain.

4.1 Connect to FTP and Setup

Follow these instructions to connect to your server using FTP and complete the application setup:

4.1.1. Connect to the server using FTP: Use an FTP client like FileZilla to connect to your server. Enter the server’s IP address, username, and password. Use port 21 for FTP or port 22 for SFTP.

4.1.2. Transfer the ZIP file: Upload your admin panel’s ZIP file to the server’s local path (e.g., /var/www/html).

4.1.3. Unzip the file: Navigate to the file’s location on the server and run the following command to extract the ZIP file: “sudo unzip your-application.zip” or you can do it from cpanel directly.

4.1.4. Update the .env file with your configuration: Modify the database and application settings which are mentioned in the .env file. Below is an example configuration:

4.1.5. Run the following command from the root directory of your admin panel terminal to install Firebase dependency modules required for scheduler functions.

4.1.6. Setup Node Js Path

To get the Node path from the terminal, you typically want to determine the location of Node.js or a specific file related to Node. Here are common ways to do this from the terminal:

To find out where Node.js is installed on your system, you can use the which command (on Linux/macOS):

which node

This will return the full path to the Node.js binary. For example:

/usr/local/bin/node

See this example: In our case, the Node.js path is something like the one below.

Copy this path and update it in your NODE_PATH variable.

4.2. CRON Job Setup

A cron job is a scheduled task in Unix-based operating systems that runs scripts or commands at specified intervals. Here’s how to set up a cron job on a server:

Steps to Set Up a Cron Job:

4.2.1. Log in to cPanel or in your web server
4.2.2. Navigate to the “Cron Jobs” Section
4.2.3. Add a New Cron Job

In the command field, enter the command or the path to the script you want to run.

For example: Run a script every minutes:

* * * * * /usr/local/bin/php /home/username/public_html/artisan schedule:run >> /dev/null 2>&1

For example: Run a script every day at midnight:

0 0 * * * /usr/local/bin/php /home/username/public_html/artisan schedule:run >> /dev/null 2>&1

4.2.4: Save the Cron Job

4.3 Map Configuration

Please choose your preferred map by navigating to the Admin Panel > General Settings > Map Tracking Options.

4.4 Notifications Settings

To work firebase push notification feature functions correctly, please upload your Firebase credentials file in the Admin Panel by navigating to General Settings > Notifications Settings.

Navigate to your Firebase Project Settings > Cloud Messaging. Under Firebase Cloud Messaging API, you will find the Sender ID.

Go to Firebase Project Settings > Service accounts, scroll down and click on the ‘Generate new private key’ button. A JSON file will be downloaded.

Steps to Configure:

To enable real-time push notifications for customers and drivers, you need to connect your application with Firebase Cloud Messaging (FCM).

1.Generate Firebase Credentials File

• Go to the Firebase Console.
• Select your project.
• Navigate to Project Settings > Service Accounts.
• Click Generate New Private Key (e.g., firebase-adminsdk-xxxxx.json).
• Keep this file safe, as it contains your Firebase API keys and credentials.

2.Upload Firebase Credentials in Admin Panel

• Log in to your CabMe Admin Panel
• Go to General Settings > Notifications Settings.
• Upload the JSON file you downloaded from Firebase

3.Save & Apply Settings

• Once uploaded, click Save/Update Settings.
• The system will now connect to Firebase for sending push notifications.

4.Verify Push Notifications

• Test by creating a new booking from the user app.
• The assigned driver should instantly receive a push notification.
• Customers will also get updates (ride accepted, driver arriving, ride started, ride completed).

4.5 Accessing the Admin Panel

Default Admin User Credentials

URL: Your desired URL where the admin panel is set up.
Email: admin@goride.com
Password: 12345678

5. Admin Panel Menus Overview

5.1. Dashboard

Provides an at-a-glance overview of the business. Displays analytics such as total customers, registered drivers, completed rides, latest rides, top drivers, and overall earnings overview. Helps admins quickly monitor performance.

5.2. Live Monitoring

Live Tracking

Monitor drivers and vehicles in real time on the map. Useful for managing rides, ensuring driver accountability, and providing live support.

Zone

Service zones allow you to define the exact areas where your platform operates, such as specific cities, regions, or neighborhoods. Within each zone, Additionally, zone-based policies give you flexibility to apply different operational rules for each area, ensuring a more accurate, efficient, and localized service experience.

5.3. Access Management

Access Control

Create and manage admin permission groups (e.g., Super Admin, Editor, Dispatcher). Control what each admin role can view or edit within the system.

5.4. Account Management

Users

The Customers page allows administrators to view and manage all customer accounts registered through the mobile application. Each profile displays essential details such as personal information, contact data, and account status. Admins can review a customer’s complete ride history, including completed, canceled, and ongoing bookings, to monitor activity and resolve issues quickly. Ensuring better coordination and customer support. This page also provides the ability to edit or deactivate accounts, helping maintain a secure and well-managed user base.

Drivers

The Drivers page provides administrators with full control over managing individual driver accounts on the platform. Each driver profile displays personal details, uploaded documents, and verification status to ensure compliance and safety. From this page, admins can review and approve driver applications, track their current availability, and monitor active or completed trips. The system also offers insights into driver earnings, commission deductions, and payout history for transparent financial management. Additionally, admins can update driver information, suspend accounts if necessary, and maintain a reliable pool of professional drivers for smooth operations.

Fleet Drivers

The Fleet Drivers page is designed to manage drivers who are associated with registered fleet owners. Unlike independent drivers, these drivers operate under a specific owner’s fleet, allowing for organized group management. Administrators can view detailed profiles of fleet-linked drivers, including assigned vehicles, and ride activity. This page also provides visibility into each driver’s earnings and commission, ensuring accurate revenue tracking between drivers, fleet owners, and the platform. By centralizing fleet-based driver management, the page helps maintain accountability and smooth coordination within larger transportation networks.

Owners

The Owners page allows administrators to manage fleet owners who register and oversee multiple drivers and vehicles within the platform. Each owner profile includes essential details such as contact information, registered vehicles, and assigned drivers. Admins can monitor the performance of each fleet, including trip activity, availability, and vehicle status. The page also provides a breakdown of owner earnings, platform commission, and payout history, ensuring financial transparency. With this centralized view, administrators can easily track fleet operations, resolve issues, and maintain strong relationships with fleet partners.

Documents

The Driver Documents page allows administrators to define and manage the documents required for verification of individual drivers and fleet owners. Admins can add new document types, such as Aadhaar Card, PAN Card, Driver License, or other ID proofs, and specify which documents must be uploaded during verification. This ensures that all necessary documentation is collected to maintain compliance, authenticity, and safety on the platform.

Reports

The Reporting and Analytics section in the admin panel provides comprehensive insights into platform activity, allowing administrators to monitor performance, make data-driven decisions, and identify trends. Reports can be customized using various filters and options to generate precise and actionable information. Key options include:

Status: Filter reports by the status of rides, trips, or transactions (e.g., completed, canceled, ongoing).

Date Options: Quickly generate reports based on preset time frames like Today, This Week, This Month, or This Year.

File Format: Export reports in multiple formats such as XLS, CSV, or PDF for offline analysis, record-keeping, or sharing with stakeholders.

User Reports

The User Reports page generates detailed reports on customer activity. Administrators can track metrics such as ride history, active and canceled bookings, wallet usage, and promotional coupon redemptions. This helps identify user engagement patterns, monitor retention, and address issues impacting the customer experience.

Driver Reports

The Driver Reports page focuses on driver performance analytics. Admins can review completed trips, acceptance and cancellation rates, earnings, ratings, and feedback. These reports help evaluate driver efficiency, reward top performers, and take corrective actions for underperforming drivers, ensuring high service quality.

Ride Reports

The Travel Reports page consolidates analytics across all service types — rides. It provides insights into total revenue, number of trips, cancellations, average trip distance, and peak usage times. This data helps in resource planning, optimizing service availability, and identifying high-demand periods to enhance operational efficiency.

Intercity Reports

The Intercity Ride Reports page consolidates analytics specific to outstation trips. It provides insights into total intercity revenue, number of completed trips, cancellations, average trip distance, driver performance, and most popular city-to-city routes. This data helps in demand forecasting, optimizing route availability, adjusting pricing strategies, and ensuring better driver allocation for long-distance travel.

Transaction Reports

The Transaction Reports page provides a comprehensive view of all financial activities across the platform. It tracks completed payments, pending transactions, refunds, discounts, commissions, and wallet activity. This data helps in monitoring revenue flow, reconciling accounts, identifying payment trends, and ensuring financial transparency between riders, drivers, and the platform.

5.5. Business Setup

Subscription Plan

The Subscription Plan page allows administrators to create and manage subscription packages for drivers and fleet owners. These plans define recurring fees that drivers or owners pay to access the platform’s services, replacing or supplementing commission-based models. Each plan can include details such as pricing, billing cycle (weekly, monthly, yearly), benefits, and usage limits. Admins can track which drivers or owners are subscribed, monitor their subscription history & payment status.

5.6. Ride Management

Rides > Services

The services page allows administrators to define and manage multiple ride categories such as Car, Rickshaw, and Bike. It provides flexibility to add, edit, or disable service types based on market demand. This helps in offering diverse transportation options to riders, ensuring better coverage of customer needs, and optimizing fleet allocation for each service category.

Rides > Ride Orders

The Ride Orders page provides a detailed view of all ride bookings made through the platform. It includes essential information such as booking ID, rider details, driver assignment, trip status, fare amount, payment method, and timestamps. Administrators can monitor active, completed, and cancelled rides in real-time, resolve disputes, and ensure smooth ride operations. This helps in maintaining transparency, improving service quality, and optimizing the overall ride management process.

Intercity > Intercity Service

Services page enables administrators to manage different outstation service categories such as Freight, Parcel, Private Ride, and Shared Ride. Each service type can be customized with specific pricing models, vehicle requirements, and availability settings. This flexibility allows businesses to cater to diverse customer needs—whether it’s transporting goods, sending parcels, booking exclusive private rides, or offering cost-effective shared travel options across cities.

Intercity > Intercity Orders

The Intercity Orders page provides a comprehensive overview of all outstation trip bookings. It displays booking ID, passenger details, selected service type (Freight, Parcel, Private Ride, or Shared Ride), driver assignment, trip status, fare breakdown, and payment information. Administrators can track ongoing, completed, and cancelled intercity rides in real-time, manage disputes, and ensure reliable service delivery. This module helps maintain transparency, optimize long-distance operations, and improve customer satisfaction for intercity travel.

Freight

Freight Vehicle management enables administrators to define and oversee vehicles used for transporting goods. It includes details like vehicle type, load capacity, size specifications, availability, and driver assignment. This ensures efficient allocation of resources, optimized freight operations, and reliable service for businesses and customers needing goods transport.

Airports

The Airports feature allows administrators to manage airport-related ride services. It includes adding airport locations, defining pick-up and drop-off points, and configuring fare rules for airport transfers. This helps ensure seamless airport rides, optimized driver allocation, and a smooth experience for passengers traveling to and from airports.

Driver Rules

Driver Rules define the specific guidelines that passengers must follow during a ride. This can include rules such as “Pets Allowed,” “No Alcohol,” “No Smoking,” or any custom conditions set by the driver. These rules help ensure a safe, comfortable, and respectful experience for both drivers and passengers while maintaining service quality and compliance.

5.7. App Management

CMS Pages

The CMS Pages section allows administrators to create, edit, and manage static content pages within the app, such as About Us, FAQs, Terms & Conditions, Privacy Policy, and more. Each page can include text, images, and links, ensuring that essential information is clearly presented to users. Admins can update content anytime to reflect changes in policies, services, or company information. This page ensures that the app provides accurate and up-to-date information, improving transparency and user trust.

Banners

The Banners page allows administrators to create, manage, and display promotional or informational banners within the customer mobile application. Each banner can include images, text, links, or call-to-action buttons to highlight offers, updates, or important announcements. Admins can control the order, duration, and visibility of banners for different user segments, ensuring relevant and engaging content. This page helps enhance user experience, promote services effectively, and drive customer engagement through visually appealing notifications.

On Boarding

The On Boarding page allows administrators to configure the introductory screens shown to new users when they first open the mobile application. These screens can highlight key app features, explain how to use services, and provide tips for a smooth experience. Admins can add images, text, and interactive elements to make the onboarding process engaging and informative. This page ensures that new users quickly understand the app’s functionality, enhancing user adoption and reducing confusion during initial use.

FAQ

The FAQ feature provides a centralized section for frequently asked questions by users. It allows administrators to add, edit, or remove questions and answers, covering topics such as booking procedures, payment methods, ride policies, and service guidelines. This helps improve user experience, reduce support requests, and ensure passengers and drivers have quick access to important information.

SOS

The SOS page enables administrators to monitor and manage emergency alerts raised by drivers or customers in real time. Each alert provides critical information such as the location, type of emergency, and the user involved. Admins can quickly track and respond to these SOS events, ensuring prompt assistance and intervention. This page helps improve safety across the platform by enabling rapid coordination, documenting incidents, and maintaining records for follow-up and preventive measures.

Help & Support

The Help & Support feature enables real-time communication between users and administrators. It includes a chat system where users can submit queries, report issues, or request assistance, and admins can respond promptly. This ensures timely support, enhances user satisfaction, and helps resolve ride-related or account issues efficiently.

5.8. Setting Management

Tax Settings

The Tax Settings page allows administrators to configure taxes applicable across all services. Admins can define tax types such as GST, VAT, or other local taxes and specify rates for each service category. This page ensures that all fare calculations include accurate tax amounts, maintains compliance with local tax regulations, and provides transparency for customers and drivers. Proper tax configuration also helps in generating accurate financial reports and simplifies accounting and regulatory reporting.

Coupons

The Coupons page enables administrators to create, manage, and monitor discount coupons and promotional codes that customers can apply during bookings. Each coupon can be configured with specific details such as discount type (percentage or fixed amount), validity dates, and maximum usage limits per customer or overall. Admins can also define which coupon applies to rides and allow for targeted promotions. This page provides visibility into coupon performance, including redemption counts and customer usage, helping businesses run effective marketing campaigns while controlling discounts and revenue impact.

Currency

The Currency page allows administrators to define and manage the currencies supported by the platform. Admins can set default currencies, add additional currencies for global operations, and configure exchange rates to ensure accurate pricing and billing across regions. This page helps maintain consistency in financial transactions, supports multi-currency operations, and ensures that both customers and drivers see correct amounts in their local currency.

Languages

The Languages page allows administrators to manage the languages available in the admin panel. Admins can add new languages, edit existing translations, and update labels or messages to ensure the interface is accessible to a diverse team. This page helps maintain consistency across the admin panel, supports multi-lingual operations, and ensures that administrators can efficiently manage the platform in their preferred language.

Payments

The Payments section provides a comprehensive view and management of all financial transactions within the platform. It includes:

Payout Requests: Tracks and manages withdrawal requests from drivers or service providers, ensuring timely and accurate payouts.

Owner Wallet Transactions: Monitors all credit and debit activities in the platform owner’s wallet, including commissions, refunds, and adjustments.

Driver Wallet Transactions: Records earnings, incentives, and deductions for drivers, providing transparency and easy reconciliation.

User Wallet Transactions: Displays top-ups, payments, refunds, and promotional credits for users, ensuring smooth and secure financial
operations.

This section helps administrators maintain transparency, manage finances efficiently, and ensure accurate tracking of all monetary activities across the platform.

Settings

Global Settings

The Global Settings page allows administrators to configure all core settings for the app, web panel, and overall platform operations. These settings ensure the platform runs smoothly, maintains consistent branding, and meets operational requirements.

Admins can define the basic platform appearance and identity:

• Title & Footer: Customize the platform’s name and footer text.
• App Color, Admin Panel Colors: Set color schemes for both mobile app and admin panel for consistent branding.
• Radius: Configure service coverage radius for rides.
• Logo: Upload platform or company logo for display across app and admin panel.
• etc.

Business Model Settings

The Business Model Settings page allows administrators to define how the platform generates revenue from drivers and fleet owners. Admins can choose between different earning models:

• Commission Model: The platform earns a percentage of each completed ride transaction.
• Subscription Model: Drivers or fleet owners pay a recurring subscription fee to access the platform’s services.
• Hybrid Model: Combines both commission and subscription-based earnings, allowing flexible revenue strategies.

This page ensures that the platform’s revenue model aligns with business objectives and provides flexibility to adapt to market demands or strategic changes. Administrators can adjust settings easily to implement the chosen model across all services.

Schedule Notification Settings

Schedule Notification Settings allow administrators to configure automated notifications for upcoming rides. They can set the timing of alerts to be sent to users and drivers, such as 1 day, several hours, or minutes before the ride. This ensures timely reminders, reduces missed bookings, and enhances overall communication and service reliability.

Payment Method

The Payment Methods page allows administrators to configure and manage the payment options available on the platform. Admins can enable or disable various gateways, including Cash, Stripe, PayPal, Razorpay, and Wallet payments, ensuring flexibility for both customers and drivers. This page ensures secure and seamless transactions, helps accommodate user preferences, and provides control over which payment methods are active for rides. Proper configuration also enables smooth reconciliation of payments and supports accurate financial reporting.

Landing Page Template

The Landing Page Template page allows administrators to manage and customize the public-facing landing page of the CabMe platform. Admins can update banners, text content, images, and branding elements to reflect current promotions, company identity, or seasonal campaigns. This page provides control over the look and feel of the landing page, ensuring it is visually appealing, informative, and aligned with marketing objectives. It helps attract new users, communicate key messages effectively, and maintain a professional online presence.

Header Template

Header Template allows administrators to customize the top section of the web application. This includes configuring the logo, navigation menus, links, and other elements visible to users. It ensures a consistent, branded interface and provides easy access to key pages and features of the website.

Footer Template

Footer Template allows administrators to customize the bottom section of the web application. This includes configuring links, contact information, social media icons, copyright text, and other elements visible to users. It ensures a consistent, branded interface and provides easy access to important information and resources across the website.

Privacy Policy

The Privacy Policy page allows administrators to create, update, and maintain the privacy policy content displayed to users within the app. Admins can ensure the policy complies with regulations such as GDPR and local data protection laws, clearly explaining how user data is collected, stored, and used. This page helps build trust with users, maintain legal compliance, and provide transparency regarding data privacy and security practices.

Terms & Conditions

The Terms & Conditions page allows administrators to create, update, and maintain the legal agreements displayed to users within the app. Admins can edit content to reflect company policies, service rules, and regulatory requirements, ensuring that users are informed about their rights and obligations. This page helps maintain legal compliance, provides transparency, and protects both the platform and its users by clearly communicating the terms of service.

Firestore Database Collection Import / Export

To perform Firebase Collection Import Export, follow these straightforward steps:

6.1. To set up NPM on your computer, download Node.js from the following link: https://nodejs.org/en/download/ Node.js Download Page.

6.2. Unzip the source code file named “Firebase Import Export Collections.zip”

6.3. If you haven’t already created a Firebase project, set it up now.

6.4. Configure the credentials.json file, which you can obtain from your Firebase Project settings. Then navigate to the Service account, then select Node.js. Generate a new private key and wait until the key is created. It will automatically download and replace the current credentials.json file.

6.5. Navigate to the extracted Firebase Import Export Collections zip file path and then press and hold the Ctrl+Shift buttons. While holding them, right-click the mouse button, and select “Open PowerShell window here” from the context menu. This will open a PowerShell window where you can run the import/export command.

6.6. Execute the following commands to perform import/export operations for collections:

To import all collections, execute the following command:

To export all collections, execute the following command:

Once the export command is executed, the collections.json file will be downloaded.

See Video:

7. Deploy Firebase Cloud Functions

All the necessary Firebase Functions have been initially coded by us, you just need to deploy these functions to your own Firebase account. This means that you need to upload the source code inside the Firebase Functions folder to your account. If a Firebase account has been created, find a Firebase project, and 2 apps (iOS and Android)

7.1. Setting up Node.js and the Firebase CLI

For comprehensive guidance, refer to the official Firebase documentation on getting started: “Write, test, and deploy your first functions” in Cloud Functions for Firebase.

You’ll need Node.js and the Firebase CLI to write functions and deploy them to Cloud Functions.

To set up NPM on your computer, download Node.js from the following link: Node.js download. Once Node.js is installed, proceed to install the Firebase CLI.

Use the following command to install the CLI via npm:

npm install -g firebase-tools

If you’ve already set up the Firebase tools, you can simply run the following command:

npm install

These steps will ensure you’re ready to start writing and deploying functions with Firebase. If you encounter any issues, consult the Firebase documentation for troubleshooting assistance.

7.2. Initialize your project

To initialize the project, authenticate the Firebase tool by running the following command. You’ll be prompted to log in to your account via your web browser:

firebase login

7.3. Implementing Cloud Functions

Since we’re providing the complete source code for your Firebase Cloud Functions:

Extract the zip file Order Tracking Firebase Function folder.zip.

Fill in the necessary credentials in the following files located within the zip:

1. .firebaserc (Add your Firestore Project ID)
2. index.js (Add your Firestore database URL)
3. serviceAccountKey.json (Add your Firebase service account credentials)

With these steps, you’ve successfully set up the required credentials.

7.4. Deploy Firebase Functions

Simply run the following command in the Order Tracking Firebase Function > functions directory.

firebase deploy --only functions

Now you can go to your Firebase Console and check, as the functions have been deployed. It is possible to see the logs for each function, understand the output, and know when it gets called.

See Video:

8. Firestore Database Indexing

To perform Firebase indexing, follow these straightforward steps:

8.1. To set up NPM on your computer, download Node.js from the following link: https://nodejs.org/en/download/

8.2. Unzip the source code file named “Firebase Indexing.zip” here.

8.3. Navigate to the extracted directory of “Firebase Indexing” zip file. Press and hold the ctrl+shift buttons, then right-click the mouse button. From the context menu, select “Open PowerShell window here” to launch Windows PowerShell and execute import/export commands.

8.4. Execute the command firebase login to log in to Firebase, if you haven’t already done so.

8.5. Execute the command firebase init

8.6. Proceed with Y and press the enter button.

8.7. Choose the Option > Firestore: Configure security rules and index files for Firestore.

8.8. Choose the Option > Use an existing project.

8.9. Choose your project

8.10. Press Enter > ? What file should be used for Firestore Rules? firestore.rules

8.11. Press Enter > ? What file should be used for Firestore indexes? (firestore.indexes.json)

8.12. Now, the firestore.indexes.json file will be downloaded. Open this file and copy all the code from firestore_indexes.json file, then paste it into firestore.indexes.json file.

8.13. Now execute the command firebase deploy --only firestore:indexes to import indexing in firestore.

See Video:

9. Owner Panel Setup

9.1 Connect to FTP and Setup

Follow these instructions to connect to your server using FTP and complete the application setup:

9.1.1. Connect to the server using FTP: Use an FTP client like FileZilla to connect to your server. Enter the server’s IP address, username, and password. Use port 21 for FTP or port 22 for SFTP.

9.1.2. Transfer the ZIP file: Upload your owner panel’s ZIP file to the server’s local path (e.g., /var/www/html).

9.1.3. Unzip the file: Navigate to the file’s location on the server and run the following command to extract the ZIP file: “sudo unzip your-application.zip” or you can do it from cpanel directly.

9.1.4. Update the .env file with your configuration: Modify the database and application settings which are mentioned in the .env file. Below is an example configuration:

Now you can access your owner panel at your desired domain

For ex: https://owner.yourdomain.com/

9.2 Owner Panel Menus Overview

9.2.1. Dashboard

Provides an at-a-glance overview of the owner’s business operations. Displays analytics such as total drivers, active rides, completed rides, ongoing rides, latest bookings, top-performing drivers, and overall earnings summary. Helps owners quickly monitor performance, track fleet efficiency, and make informed operational decisions.

9.2.2. Document Verification

Document Verification allows owners to securely upload and submit required documentation for approval. This can include identity proof, business licenses, vehicle registration, and other necessary certificates. The system ensures that all submitted documents are verified before activating the owner’s account, helping maintain compliance, safety, and trust on the platform.

9.2.3. Drivers

The Drivers menu allows owners to manage all drivers in their fleet. It includes adding new drivers, viewing driver profiles, tracking ride assignments, and monitoring performance metrics. This helps owners efficiently allocate drivers, oversee ongoing operations, and ensure smooth service delivery across all bookings.

9.2.4. Ride Orders

The Ride Orders section provides owners with a detailed view of all rides booked under their fleet. It displays booking details, rider information, assigned driver, trip status, fare breakdown, and payment method. This helps owners track active, completed, and cancelled rides, monitor fleet performance, and ensure timely service delivery..

9.2.5. Intercity Orders

The Intercity Orders section provides owners with a comprehensive view of all outstation trips under their fleet. It includes booking details, passenger information, selected service type (Freight, Parcel, Private Ride, or Shared Ride), assigned driver, trip status, fare breakdown, and payment method. This helps owners monitor ongoing, completed, and cancelled intercity rides, optimize long-distance operations, and ensure reliable service for passengers.

9.2.6. My Subscriptions

The My Subscriptions section allows owners to view and manage their active subscription plans on the platform. It displays details such as subscription type, start and expiry dates, features included, payment history, and renewal options. This helps owners keep track of their plan benefits, ensure uninterrupted access to platform services, and manage upgrades or renewals efficiently.

9.2.7. Change Subscription

The Change Subscription feature allows owners to upgrade, downgrade, or switch their current subscription plan. It provides details of available plans, pricing, features, and renewal options. This helps owners select the most suitable plan for their business needs, ensuring access to desired features and optimal platform usage.

9.2.8. My Wallet Transactions

The My Wallet Transactions section provides owners with a detailed record of all wallet activities. It includes credits, debits, payouts, refunds, and adjustments related to their account. This helps owners track financial activity, monitor earnings, reconcile transactions, and maintain transparency in platform-related finances.

9.2.9. Payouts

The Payouts section allows owners to view and manage withdrawal requests from their platform wallet. It displays details such as requested amount, request date, payment method, and status of the payout. This helps owners track earnings, ensure timely withdrawals, and maintain clear financial records for their business.

10. Landing Panel Setup

10.1 Connect to FTP and Setup

Follow these instructions to connect to your server using FTP and complete the application setup:

10.1.1. Connect to the server using FTP: Use an FTP client like FileZilla to connect to your server. Enter the server’s IP address, username, and password. Use port 21 for FTP or port 22 for SFTP.

10.1.2. Transfer the ZIP file: Upload your landing panel’s ZIP file to the server’s local path (e.g., /var/www/html).

10.1.3. Unzip the file: Navigate to the file’s location on the server and run the following command to extract the ZIP file: “sudo unzip your-application.zip” or you can do it from cpanel directly.

10.1.4. Update the .env file with your configuration: Modify the database and application settings which are mentioned in the .env file. Below is an example configuration:

Now you can access your landing page at your desired domain

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

11. Create Google Map API Key

11.1. Go to the Google Maps Platform

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

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

11.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.

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

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

11.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.

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

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

12. 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.

12.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.

12.2. Download the our latest version source code from codecanyon and apply.

2. Setup Setting up Flutter involves several steps. Here’s a basic guide to get you started:

2.1. System Requirements:

Ensure your system meets the minimum requirements for Flutter development. Flutter supports development on Windows, macOS, and Linux. Make sure your system has the necessary hardware and software requirements as specified by Flutter documentation.

2.2. Install Flutter SDK:

Download the Flutter SDK from the official Flutter website.

Extract the downloaded file to a location on your system. For example, on macOS or Linux, you can extract it to /usr/local and on Windows to C:\.

Add the Flutter bin directory to your system PATH to run Flutter commands from the command line. This step is important for executing Flutter commands globally in your system.

2.3. Install Development Tools:

For Android: Install Android Studio and configure the Flutter plugin. Android Studio provides the Android SDK, which Flutter uses to develop for Android. Ensure you have the Android SDK and the necessary tools installed through Android Studio.

For iOS: You need a macOS system with Xcode installed to develop and deploy Flutter apps for iOS.

2.4. Set up Android Emulator or iOS Simulator:

For Android development, set up an Android Virtual Device (AVD) using Android Studio’s AVD Manager.

For iOS development, use the iOS Simulator provided by Xcode.

Run flutter doctor:

Open a terminal and run flutter doctor. This command checks your system for any dependencies needed for Flutter development.

It will provide feedback on any missing or outdated components and instructions on how to resolve them.

2.5. Install Flutter and Dart plugins for your preferred IDE:

If you’re using VS Code, install the Flutter and Dart plugins to enhance your development experience.

Android Studio also has built-in support for Flutter, but make sure to install the Flutter plugin if it’s not already installed.

2.6. Create your first Flutter project:

Use the flutter create command to create a new Flutter project.

Navigate to the project directory and explore the file structure. You’ll find the main Dart file (main.dart) in the lib directory, where you’ll write your Flutter code.

2.7. Run your Flutter app:

Connect a device or start an emulator/simulator.

Navigate to your Flutter project directory in the terminal and run flutter run.

This will compile your Flutter app and launch it on the connected device or
emulator.

2.8. Start Developing:

Once your app is running, you can start developing your Flutter UI and logic. Flutter’s hot reload feature allows you to see your changes instantly without restarting the app.

2.9. Learn and Explore:

Flutter has an extensive set of widgets and libraries. Explore the official Flutter documentation and community resources to learn more about Flutter development.

3. Flutter Android Setup

3.1 Changing the package name:

Navigate to the android directory within your Flutter project.

Open the AndroidManifest.xml file located in the app/src/main directory.

File Location: "project/android/app/src/main/AndroidManifest.xml"

Find the package attribute in the tag and change its value to your desired package name.

3.2 Update Android source code references:

Open the MainActivity.java file located in android/app/src/main/java/com/your_old_package_name.

Replace occurrences of the old package name with the new package name.

3.3 Change the launcher icon :

3.3.1. Prepare Your New Icons:

First, prepare the new launcher icon images in the required sizes. Android and iOS have different size requirements. You typically need icons in various sizes to support different screen densities.

For Android, you need to replace the existing launcher icon files with your new ones. The launcher icons for Android are stored in the mipmap folders inside the android/app/src/main/res directory.

Replace the existing icon files (ic_launcher.png) in the mipmap folders with your new icon files. Make sure to maintain the same file names and sizes.

You may need to replace icons in various drawable folders for different screen densities (e.g., mipmap-hdpi, mipmap-mdpi, mipmap-xhdpi, mipmap-xxhdpi, mipmap-xxxhdpi).

3.4. Change the app name

3.4.1. For Open the android/app/src/main/AndroidManifest.xml file.

3.4.2. Locate the tag.

3.4.3. Change the value of the android:label attribute to your desired app name.

3.5. Change the Google Maps API key :

3.5.1. Navigate to your Flutter project’s android/app/src/main/AndroidManifest.xml file.

3.5.2. Inside the element, locate the tag with the name com.google.android.geo.API_KEY.

3.5.3. Replace the android:value attribute with your new Google Maps API key.

<meta-data
android:name="com.google.android.geo.API_KEY" android:value="YOUR_API_KEY_HERE"/>

3.6.Change the API key and base URL :

3.6.1. Open the pp/lib/service/api.dart file:
Navigate to the specified file path in your Flutter project directory.
Open the app/lib/service/api.dart file using a text editor or an IDE.

3.6.2. Explanation

3.6.2.1. -keystore: The path where the .jks file will be created (~/my-release-key.jks for Unix/macOS, C:\Users\YourName\my-release-key.jks for Windows).

3.6.2.2. -keyalg RSA: Algorithm used.

3.6.2.3. -keysize 2048: Key length.

3.6.2.4. -validity 10000: Validity in days (~27 years).

3.6.2.5 -alias my-key-alias: Name of the key within the keystore.

3.6.3. Enter Required Info

3.6.3.1.Keystore password

3.6.3.2.Key password

3.6.3.3.Your name, organization, city, state, and country code

3.6.4. Configure key.properties in Flutter Project

3.6.4.1.Create a file: android/key.properties

storePassword=your-store-password
keyPassword=your-key-password
keyAlias=my-key-alias
storeFile=/Users/yourusername/my-release-key.jks

3.7.To generate SHA-1 and SHA-256 keys :

(This important for Phone Auth, Google Sign-In )

3.7.1.Using Keytool:

3.7.1.1.Navigate to your JDK’s bin directory in the command line.

3.7.1.2.Execute the following command to generate the SHA-1 key:

keytool -list -v -keystore path-to-your-keystore-file -alias your-alias-name

3.7.1.3.Replace path-to-your-keystore-file with the path to your keystore file (usually debug.keystore for debug builds and a custom keystore for release builds) and your-alias-name with the alias name used to generate the keystore.

3.7.1.4.Similarly, execute the following command to generate the SHA-256 key:

keytool -list -v -keystore path-to-your-keystore-file -alias your-alias-name -storetype PKCS12 -keyalg RSA

3.7.2.Using Gradle (Android Studio):

3.7.2.1. Open your Flutter project in Android Studio.

3.7.2.2. In the Android view, navigate to app -> Gradle Scripts -> build.gradle (Module: app).

3.7.2.3. Add the following lines to the android block

android {
    ...
    signingConfigs {
        debug {
            storeFile file('path-to-debug.keystore')
            storePassword 'password'
            keyAlias 'key-alias'
            keyPassword 'password'
        }
    }
}

3.7.2.4. Replace path-to-debug.keystore, password, and key-alias with your keystore file path, password, and key alias respectively.

3.7.2.5. Sync your project to apply changes.

3.7.2.6. Run the following Gradle task in the terminal to get the SHA-1 and SHA-256 keys

./gradlew signingReport

3.7.3. Adding Keys to Firebase Console:

3.7.3.1. Go to the Firebase Console.

3.7.3.2. Select your project.

3.7.3.3. For Android:

Click on the Android icon to add an Android app.

Follow the setup instructions, including adding the google-services.json file to your Flutter project’s android/app directory.

During setup, you’ll be asked for your SHA-1 key. Paste the SHA-1 key you generated earlier.

After setup is complete, you’ll have the option to download the google-services.json file again. Replace the existing file in your project if needed.

3.7.3.4.For IOS:

Click on the iOS icon to add an iOS app.
Follow the setup instructions, including downloading the GoogleService-Info.plist file.

There’s no need to add SHA-1 or SHA-256 keys for iOS.
Add the downloaded GoogleService-Info.plist file to your Flutter project’s ios/Runner directory.

4.Flutter IOS setup

4.1. Change the iOS bundle identifier:

1. Navigate to the ios directory within your Flutter project.
2. Open the Runner.xcodeproj project file using Xcode.
3. In Xcode, select the Runner project from the project navigator.
4. Go to the Runner target’s settings.
5. Under the General tab, find the Bundle Identifier field and change it to your desired bundle identifier.

4.2. To change the launcher icon

4.2.1. For iOS, you need to replace the existing icon files with your new ones. The icons for iOS are stored in the Assets.xcassets directory in the ios/Runner directory.

4.2.2. Open your Flutter project in Xcode by navigating to the ios directory and opening the .xcworkspace file with Xcode.

4.2.3. In Xcode, navigate to Runner > Assets.xcassets.

4.2.4. Replace the existing AppIcon with your new icon files. You’ll typically find different sizes labelled for various devices (e.g., iPhone, iPad).

4.3. Change Application Name in IOS.

4.3.1. Open the ios/Runner/Info.plist file.

4.3.2. Locate the CFBundleDisplayName entry.

4.3.3. Change the value associated with to your desired app name.

4.4. To change the Google Maps API key.

4.4.1. Open your Flutter project in a text editor or IDE.

4.4.2. Navigate to the ios/Runner directory within your Flutter project.

4.4.3. Locate the AppDelegate.swift file.

4.4.4. In the didFinishLaunchingWithOptions method, set the Google Maps API key.

Replace “YOUR_NEW_API_KEY_HERE” with your actual Google Maps API key.

After updating the API key in the AppDelegate.swift file, rebuild your Flutter app for iOS to apply the changes.

By following these steps, your Flutter app will use the new Google Maps API key specifically for iOS. Make sure you’ve also updated the API key in the Android configuration as described earlier if you want to apply changes to both platforms.

5. Flutter Firebase Setup

5.1. Setting up Firebase for a Flutter project using the Firebase CLI involves several steps. Below is a detailed guide on how to do it:

5.1.1. Install Firebase CLI:

First, you need to install the Firebase CLI if you haven’t already. You can install it via npm (Node Package Manager) by running the following command in your terminal or command prompt:

5.1.2. Login to Firebase:

After installing the Firebase CLI, log in to your Firebase account by running the following command:

This will open a browser window prompting you to log in to your Google account associated with Firebase.

5.1.3. Create a Firebase Project:

If you haven’t already created a Firebase project, you can create one using the Firebase CLI by running:

Follow the prompts to create a new project.

5.1.4. Initialize Firebase in Your Flutter Project:

Navigate to your Flutter project directory in the terminal.

Initialize Firebase in your project by running:

This command will prompt you to select the Firebase features you want to set up. Choose the Firebase services you intend to use, such as Authentication, Firestore, etc.

5.1.5. Configure Firebase:

During the initialization process (firebase init), you’ll be asked to select the Firebase project you created or configured earlier. Choose the appropriate project from the list.

5.1.6. Install Required Dependencies:

After selecting the Firebase features, Firebase CLI will generate the necessary configuration files for your project.

Next, you need to install the required Firebase packages in your Flutter project. You can do this by adding the dependencies to your pubspec.yaml file:

Replace latest_version with the actual version numbers of the Firebase plugins you want to use. You can find the latest versions on pub.dev.

5.1.7. Initialize Firebase in Your Flutter App:

5.1.8. Using Firebase Services:

Now you can use Firebase services in your Flutter app. Import the necessary Firebase packages and follow the respective documentation for each service you want to use (e.g., Firebase Authentication, Cloud Firestore).

5.1.9. Testing:

Run your Flutter app on a device or emulator to verify that Firebase services are correctly integrated and working.

5.2. Configuring and setting up FlutterFire in your Flutter project involves several steps. Here’s a detailed guide on how to do it:

5.2.1. Create a Firebase Project:

Go to the Firebase Console: https://console.firebase.google.com/

Click on “Add Project” and follow the instructions to create a new project.

Once your project is created, you’ll be redirected to the project dashboard.

5.2.2. Add an App to Your Firebase Project:

In the Firebase console, select your project.

Click on the “Add app” button (usually represented by an Android or iOS icon).

Follow the setup instructions to register your app with Firebase.

Download the google-services.json file for Android or GoogleService-Info.plist file for iOS. These files contain your Firebase project configuration details.

5.2.3. Flutter Project Setup:

Open your Flutter project in your preferred editor.

Navigate to the android/app directory for Android or ios/Runner directory for iOS, and paste the google-services.json (for Android) or GoogleService-Info.plist (for iOS) file that you downloaded earlier.

5.2.4. Add Firebase SDK to Your Flutter Project:

Open your Flutter project’s pubspec.yaml file.

Add the following dependencies:

Replace latest_version with the latest version numbers of the Firebase plugins you want to use. You can find the latest versions on pub.dev.

5.2.5. Using Firebase Services:

You can now use Firebase services in your Flutter app. Import the necessary Firebase packages and follow the respective documentation for each service you want to use (e.g., Firebase Authentication, Cloud Firestore).

5.2.6. Testing:

Run your Flutter app on a device or emulator to verify that Firebase services are correctly integrated and working.

6. Payment Methods Configuration

Path:

Administration Settings > Payment Methods

1. Stripe

• Enable Stripe: Checkbox to activate the Stripe payment gateway.
• Stripe Key: Field for entering the public API key provided by Stripe.
• Stripe Secret: Field for entering the secret API key for secure server communication.

Steps to Configure:

1. Go to Administration Settings > Payment Methods > Stripe.
2. Check Enable Stripe.
3. Enter the Stripe Key and Stripe Secret.
4. Click Save.

2. COD (Cash on Delivery)

• Enable COD: Checkbox to activate the COD payment method.

Steps to Configure:

1. Go to Administration Settings > Payment Methods > COD.
2. Check Enable COD.
3. Click Save.

4. Razorpay

• Enable Razorpay: Checkbox to activate the Razorpay payment gateway.
• Razorpay Key: Field for entering the Razorpay API key.
• Razorpay Secret: Field for entering the Razorpay secret key.

Steps to Configure:

1. Go to Administration Settings > Payment Methods > Razorpay.
2. Check Enable Razorpay.
3. Enter the Razorpay Key and Razorpay Secret.
4. Click Save.

5. PayPal

• Enable PayPal: Checkbox to activate the PayPal payment gateway.
• Client ID: Enter the PayPal Client ID.
• Client Secret: Enter the PayPal Secret Key.

Steps to Configure:

1. Go to Administration Settings > Payment Methods > PayPal.
2. Check Enable PayPal.
3. Enter the Client ID and Client Secret.
4. Click Save.

6. Wallet

• Enable Wallet: Checkbox to activate the internal wallet system.
• No additional configurations required beyond enabling the wallet feature.

7. PayFast

• Enable PayFast: Checkbox to activate the PayFast gateway.
• Merchant ID: Enter the PayFast Merchant ID.
• Merchant Key: Enter the PayFast Merchant Key.

Steps to Configure:

1. Go to Administration Settings > Payment Methods > PayFast.
2. Check Enable PayFast.
3. Enter the Merchant ID and Merchant Key.
4. Click Save.

8. PayStack

• Enable PayStack: Checkbox to activate the PayStack gateway.
• PayStack Key: Enter the PayStack API Key.
• PayStack Secret: Enter the PayStack Secret Key.

Steps to Configure:

1. Go to Administration Settings > Payment Methods > PayStack.
2. Check Enable PayStack.
3. Enter the PayStack Key and PayStack Secret.
4. Click Save.

9. FlutterWave

• Enable FlutterWave: Checkbox to activate the FlutterWave payment gateway.
• Public Key: Enter the FlutterWave Public Key.
• Secret Key: Enter the FlutterWave Secret Key.

Steps to Configure:

1. Go to Administration Settings > Payment Methods > FlutterWave.
2. Check Enable FlutterWave.
3. Enter the Public Key and Secret Key.
4. Click Save.

10. MercadoPago

• Enable MercadoPago: Checkbox to activate the MercadoPago payment gateway.
• Public Key: Enter the MercadoPago Public Key.
• Access Token: Enter the MercadoPago Access Token.

Steps to Configure:

1. Go to Administration Settings > Payment Methods > MercadoPago.
2. Check Enable MercadoPago.
3. Enter the Public Key and Access Token.
4. Click Save.

11. Xendit

• Enable Xendit: Checkbox to activate the Xendit payment gateway.
• API Key: Enter the Xendit API Key.

Steps to Configure:

1. Go to Administration Settings > Payment Methods > Xendit.
2. Check Enable Xendit.
3. Enter the API Key.
4. Click Save.

12. OrangePay

• Enable OrangePay: Checkbox to activate the OrangePay gateway.
• API Key: Enter the OrangePay API Key.

Steps to Configure:

1. Go to Administration Settings > Payment Methods > OrangePay.
2. Check Enable OrangePay.
3. Enter the API Key.
4. Click Save.

13. MidTrans

• Enable MidTrans: Checkbox to activate the MidTrans payment gateway.
• Merchant ID: Enter the MidTrans Merchant ID.
• API Key: Enter the MidTrans API Key.

Steps to Configure:

1. Go to Administration Settings > Payment Methods > MidTrans.
2. Check Enable MidTrans.
3. Enter the Merchant ID and API Key.
4. Click Save.

7. Frequently Asked Questions

7.1. What should I do if I get the error message “Missing project_info object” in my Flutter project?

The error message you’re encountering, “Missing project_info object,” typically arises in Flutter projects when there’s a misconfiguration or missing information related to Firebase services. Here’s how you can troubleshoot and potentially resolve this issue

Solution :

1. Check google-services.json: If you’re using Firebase services in your Flutter app, ensure that you have the google-services.json file placed in the correct location within your Android project. This file contains important configuration information for Firebase services. It should be located in the android/app directory of your Flutter project.

2. Verify Firebase Setup: Double-check that you’ve completed all the necessary steps to set up Firebase for your Flutter project. This includes adding your app to the Firebase project using the Firebase Console, downloading and adding the google-services.json file to your Android project, and configuring Firebase services in your Flutter app’s code (if applicable).

3. Update Google Services Plugin: Ensure that you’re using the latest version of the Google Services Gradle plugin in your Android project. You can check the latest version on the Google Services Gradle Plugin page and update the version number in your android/build.gradle file accordingly.

4. Check Flutter and Firebase Versions Compatibility: Make sure that you’re using compatible versions of Flutter and Firebase. Sometimes, using outdated versions of either can lead to compatibility issues. Refer to the Firebase Flutter documentation and ensure compatibility with your Flutter version.

5. Sync Gradle Files: After making any changes to your Android project configuration, such as updating the google-services.json file or modifying the Gradle build files, make sure to sync your Gradle files in Android Studio. This can be done by clicking on the “Sync Project with Gradle Files” button.

6. Rebuild the Project: After ensuring all configurations are correct, try rebuilding your Flutter project. You can do this by running flutter clean followed by flutter pub get and then rebuilding the project (flutter run or flutter build).

7. Check for Error Logs: Look for more detailed error messages or stack traces in the console output or build logs. These can provide additional clues about the underlying issue causing the “Missing project_info object” error.