Introduction

Overview of OvoRide - The Complete Cross Platform Ride Sharing Solution

OvoRide is a complete ride-sharing solution designed to simplify transportation and connect riders with drivers seamlessly. With dedicated apps for both riders and drivers, plus a powerful admin panel for total control, OvoRide offers a robust, feature-rich platform for managing ride services efficiently. Whether you're looking to launch a ride-hailing business or optimize fleet operations, OvoRide is your all-in-one solution.

Thank you for choosing OvoRide If you have any questions not covered in this documentation, please feel free to reach out to us via email. We’re here to assist and will respond as promptly as possible. Thank you again!

Prerequisites

All the prerequisites before starting with OvoRide.

  1. Google Map API Key: The Google Maps API is a paid service provided by Google, and its pricing starts at $5 per 1000 requests, depending on the usage and service type. The cost is calculated based on factors such as the number of map loads, directions requested, and geocoding operations performed. To integrate this service into OvoRide, you need to purchase and configure a valid API key through the Google Cloud Console. Ensure that your account has a billing setup to enable the API functionality. For detailed pricing and usage limits, visit the Google Maps API Pricing page
  2. Google Firebase: Firebase is a powerful backend platform provided by Google, essential for integrating features such as push notifications into OvoRide. To get started, you need to set up your project in the Firebase Console and configure it with your app. The setup involves creating a Firebase project, enabling necessary services, and downloading the configuration files to integrate with the app. For more info visit the Google Firebase
  3. Pusher: Pusher is a reliable service for implementing real-time features such as live updates and instant notifications in OvoRide. To set it up, create an account on the Pusher Dashboard and generate your app credentials. You’ll need to configure these credentials in your application to establish a seamless connection. Pusher provides easy-to-follow Setup Documentation to guide you through the integration process. Ensure you enable the required channels and events for optimal functionality.

Server Requirements

All server requirements are stated bellow

  • PHP Version 8.3 or 8.3+
  • MySQL Version 8.0+ or MariaDB version 10.6+
  • BCMath PHP Extension
  • Ctype PHP Extension
  • cURL PHP Extension
  • DOM PHP Extension
  • Fileinfo PHP Extension
  • GD PHP Extension
  • JSON PHP Extension
  • Mbstring PHP Extension
  • OpenSSL PHP Extension
  • PCRE PHP Extension
  • PDO PHP Extension
  • pdo_mysql PHP Extension
  • Tokenizer PHP Extension
  • XML PHP Extension
  • Filter PHP Extension
  • Hash PHP Extension
  • Session PHP Extension
  • Zip PHP Extension
  • allow_url_fopen()
  • file_get_contents()

Installation

Application installation process

Installation Steps:

  • Upload the downloaded files directly to your server after purchase to begin setup.
  • Extract the downloaded file and move all contents from the Files folder to your desired installation directory. Ensure that both index.php and .htaccess are included.
  • Quickly set up your database using the Database Wizard/Manager in your control panel.
  • After creating the database, access phpMyAdmin on your server, select the newly created database, and import the project database from the Files/Installation folder.
  • After importing the database, configure the database credentials in the .env file and update the necessary environment variables.
  • Installation is almost complete. Your site is now ready to browse. Simply visit http://your-site-url/admin and log in with the credentials below
    • username:admin
    • password:admin

Folder Structure

Important details about the application folder structure

  • assets
  • core
  • .htaccess
  • index.php
  • In the assets folder, you'll find all the necessary assets such as CSS, JS, and images. If you need to edit or modify any CSS or JS, this is the folder to access.
  • The core folder contains the core Laravel files, maintaining the full MVC structure of the project for seamless functionality and organization.

Admin Dashboard

Overview of the admin dashboard

Rides

Overview of the all rides

Riders

Overview of the platform Riders

Driver

Overview of the platform Drivers

Driver Deposit

Overview of the platform Deposit

Driver Withdrawals

Overview of the platform Withdrawals

Payment Gateway

Overview of the platform-integrated payment gateway

Withdrawal Methods

Withdrawal methods overview

General Setting

General settings overview

Brand Setting

Brand settings overview

System Configuration

System configuration overview

Notification Setting

Notification setting overview

Pusher Setting

Pusher setting overview

Get Pusher App Credentials

  1. Sign Up or Log In to Pusher: Visit the official Pusher website and create an account if you don’t already have one. If you already have an account, log in to access your dashboard.
  2. Create a New App: Once logged in, navigate to the "Apps" section of your dashboard. Click on the Create App button and fill in the required details such as app name, cluster region, and type of app (e.g., Channels).
  3. Configure App Settings: After creating the app, go to the app’s settings page. Here, you can enable or disable features like client events, presence channels, or authentication as per your requirements.
  4. Get Your App Credentials: Navigate to the App Keys or Credentials section. Copy the following details:App ID,Key,Secret and Cluster
  5. Update Pusher Settings: Log in to the admin panel, go to General Settings, and configure the credentials in the Pusher Settings section.

Still facing issues configuring Pusher credentials? Watch our step-by-step video guide to get it resolved quickly!

Google Maps API Setup Guide

This guide will walk you through the complete process of creating, configuring, and securing Google Maps API keys for OvoRide application. You will create both a Server API Key for backend services and a Client API Key for web, Android, and iOS applications.

Google Maps integration requires two separate API keys. Each key serves a different purpose and must be properly restricted to protect your project from unauthorized usage and unexpected billing charges.

Part 1 — Create a Server API Key

The Server API Key is used only in your backend or server-side environment. This key is responsible for APIs such as route calculations, geocoding, directions, and place lookups.

Step 1 — Open Google Cloud Console

Visit console.cloud.google.com and sign in using your Google account.

Google Cloud Console
Google Cloud Console Login
Step 2 — Create or Select a Project

Click the project selector from the top navigation bar. You can either select an existing project or create a completely new one.

To create a new project:

  • Click New Project
  • Enter your project name
  • Select organization if required
  • Click Create
Create Project
Step 3 — Complete Project Information

While creating the project, Google may ask for additional information such as organization details or billing configuration.

Project Information
Step 4 — Select the Newly Created Project

After the project is created successfully, select it from the project dropdown menu located at the top navigation area.

Select Project
Step 5 — Open APIs & Services Library

From the left sidebar navigation, go to:

API Library

APIs & Services → Library

This section allows you to enable all Google APIs required for your application.

Step 6 — Enable Geocoding API

Search for Geocoding API and click Enable.

This API is used for converting addresses into geographic coordinates and coordinates back into readable addresses.

API Library
Google API Library
Enable Geocoding API
Step 7 — Initial API Key Generation

After enabling the first API, Google may automatically generate an API key. You can use this key later after applying proper restrictions.

Generated API Key
Step 8 — Enable Directions API

Search for Directions API and enable it.

This API powers route calculations, distance estimation, and travel duration features.

Directions API
Enable Directions API
Directions API Enabled
Step 9 — Enable Places API

Search for Places API and enable it.

This API allows your application to retrieve location details, search suggestions, and place information.

Enable Places API
Step 10 — Create API Credentials

Navigate to:

APIs & Services → Credentials

Click Create Credentials and select API Key.

Create API Key
Step 11 — Restrict the Server API Key by IP Address

Open the generated API key settings and apply restrictions.

Under Application Restrictions, select:

IP Addresses

Add your server IP address so only your server can use this key.

API Restriction
IP Restriction
Step 12 — Find Your Server IP Address

If you are using cPanel hosting, your server IP address is usually visible on the cPanel dashboard sidebar.

You can also contact your hosting provider if you cannot locate the server IP.

Find Server IP
Step 13 — Add the Server API Key to Your Admin Panel

Copy the generated Server API Key and paste it into your application's Google Maps settings section.

Admin Panel Settings

Important Security Notice: Never expose your Server API Key in frontend applications, public repositories, or client-side JavaScript files. Always restrict this key using server IP addresses.

Part 2 — Create a Client API Key

The Client API Key is used for browser-based map features such as loading Google Maps, displaying locations, generating routes, and other frontend map functionalities. Since this key is exposed in the browser, applying proper API and domain restrictions is strongly recommended for security purposes.

Step 1 — Create Another API Key

Go back to the Credentials section and create a second API key specifically for frontend and mobile applications.

Create Client Key
Client Key Credentials
Step 2 — Enable Maps JavaScript API

Search for Maps JavaScript API and enable it. This API is required for displaying maps on your website.

Maps JavaScript API
Enable Maps JavaScript API
Maps API Enabled
Step 3 — Enable Places API

Enable the Places API to support location search, autocomplete suggestions, and place details in frontend applications.

Places API
Enable Places API
Step 4 — Restrict Client Key for Websites

Under Application Restrictions, choose:

HTTP Referrers (Websites)

Add your website domain in this format:

https://yourdomain.com/*
Website Restriction
Step 5 — Add Client API Key to Your Admin Panel

Copy the Client API Key and paste it into your application's Google Maps configuration settings.

Client API Key
Client API Key Settings

Restriction Required: Client API keys are publicly visible inside browsers and mobile applications. Always apply domain, package name, or bundle identifier restrictions to prevent unauthorized access and billing abuse.

Part 3 — Create an API Key for Android Apps

The Android API Key is used for Google Maps features inside Android applications, such as displaying maps, showing user locations, generating directions, and other mobile map functionalities. Since the key is embedded within the Android app, applying proper package name and SHA-1 certificate restrictions is highly recommended to prevent unauthorized usage and protect your Google Cloud quota.

Step 1 — Create Another API Key

Go back to the Credentials section and create a second API key specifically for frontend and mobile applications.

Create Client Key
Client Key Credentials
Step 2 — Enable Maps JavaScript API

Search for Maps JavaScript API and enable it. This API is required for displaying maps on your app.

Maps JavaScript API
Step 3 — Enable Maps SDK for Android

Enable Maps SDK for Android if your application includes an Android app.

Android SDK
Enable Android SDK
Step 4 — Enable Places API

Enable the Places API to support location search, autocomplete suggestions, and place details in frontend applications.

Places API
Enable Places API
Step 5 — Restrict API Key for Android

Select Android Apps and add your application's package name and SHA-1 certificate fingerprint.

Android Restriction

Restriction Required: Client API keys are publicly visible inside browsers and mobile applications. Always apply domain, package name, or bundle identifier restrictions to prevent unauthorized access and billing abuse.

Part 4 — Create an API Key for iOS Apps

The iOS API Key is used for Google Maps features inside iOS applications, such as displaying maps, showing user locations, generating routes, and other mobile map functionalities. Since the key is embedded within the iOS application, applying proper bundle identifier restrictions is strongly recommended to prevent unauthorized usage and secure your Google Cloud resources and quota.

Step 1 — Create Another API Key

Go back to the Credentials section and create a second API key specifically for frontend and mobile applications.

Create Client Key
Client Key Credentials
Step 2 — Enable Maps JavaScript API

Search for Maps JavaScript API and enable it. This API is required for displaying maps on your app.

Maps JavaScript API
Step 3 — Enable Maps SDK for iOS

Enable Maps SDK for iOS if your application includes an iOS app.

iOS SDK
Enable iOS SDK
Step 4 — Enable Places API

Enable the Places API to support location search, autocomplete suggestions, and place details in frontend applications.

Places API
Enable Places API
Step 5 — Restrict Client Key for iOS

Select iOS Apps and add your application's bundle identifier.

iOS Restriction

Restriction Required: Client API keys are publicly visible inside browsers and mobile applications. Always apply domain, package name, or bundle identifier restrictions to prevent unauthorized access and billing abuse.

Security & Billing Responsibility

Properly securing your Google Maps API keys is your responsibility. Incorrectly configured or unrestricted API keys may result in unauthorized usage, quota exhaustion, or unexpected Google Cloud billing charges.

Disclaimer: We are not responsible for API key misuse, accidental exposure, unauthorized access, or billing charges caused by improperly secured API keys.

For additional information, review the official Google Maps API Security Best Practices documentation.

Extensions

Overview of the platform integrated extensions

Manage SEO

Platform SEO customization overview

Localization

Overview of platform localization settings

Information

Overview of application information and technologies

Support

How to get assistance

Email Us: [email protected]