Poolmate Web Documentation

Introduction

Poolmate is a user-friendly ride-sharing application designed to make your daily commute convenient, cost-effective, and eco-friendly. Whether you’re heading to work, a social event, or running errands, Poolmate connects you with reliable drivers or fellow passengers heading in the same direction, ensuring a seamless and enjoyable ride-sharing experience.

Key Features:

1. Easy Booking:

a. Quick Ride Requests: Effortlessly book a ride with just a few taps on your smartphone.

b. Scheduled Rides: Plan your trips in advance by scheduling rides for specific dates and times.

2. Smart Matching:

a. Real-time Matching: Get paired with drivers or passengers heading in the same direction to minimise detours and reduce travel time.

b. Customizable Preferences: Set your preferences for ride companions, including gender, smoking preferences, and more.

3. Cost-Effective Rides:

a. Fare Splitting: Share the cost of the ride with fellow passengers, making your commute more affordable.

b. Transparent Pricing: View fare estimates before booking and enjoy no hidden charges.

4. Safety and Security:

a. Driver and Passenger Ratings: Check ratings and reviews to ensure a safe and reliable ride.

b. Verified Profiles: All users are required to verify their identities, adding an extra layer of security.

5. Convenient Payment Options:

a. Multiple Payment Methods: Pay for your rides using credit/debit cards, digital wallets, or cash.

b. In-App Wallet: Manage your payments effortlessly with the in-app wallet feature.

6. 24/7 Customer Support:

a. Dedicated Support Team: Get assistance anytime with our dedicated customer support team available around the clock.

1.2 Basic knowledge required to setup

1.2.1 : Real server Server related knowledge like apache or local machine server, we preferred to use a real server.

1.2.2 : Server related knowledge and we preferred cPanel in your server for quick installation.

1.2.3 : Basic knowledge in PHP, Laravel and Flutter if you want to do some customization yourself (Not compulsory).

1.2.4 : Basic knowledge about google cloud and firebase.

2. Server Requirement

2.1 : Laravel 10.x requires a minimum PHP version of 8.1

2.2 : Support for MySQL v5.7

2.3 : Apache Server (Recommended)

2.4 : Mod_rewrite Apache

2.5 : PDO Extension and other required modules of PHP

2.6 : Firebase Account

2.7 : Firebase Database

2.8 : Google MAP API Key

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

See Video: How to setup & configure Firebase Project?

4. Firestore Database Collection Import Export

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

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

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

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

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

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

4.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: How to Import Export Collections in Firebase?

5. Firestore Database Indexing

To perform Firebase indexing, follow these straightforward steps:

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

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

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

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

5.5 : Execute the command firebase init

5.6 : Proceed with Y and press the enter button.

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

5.8 : Choose the Option > Use an existing project

5.9 : Choose your project

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

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

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

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

See Video: How to Import Firestore Database Indexing in Firebase?

6. Admin Panel Setup

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.

6.1 Create Database

6.1.1 : Create a new database from your server’s MYSQL database.

6.1.2 : Create New Database

6.1.3 : Create a new database user

6.1.4 : Connect the database to the newly created database user.

6.1.5 : Grant all privileges to your user by selecting “All PRIVILEGES” and then clicking on “Make Changes”

6.2 Configure Admin Panel

6.2.1 : Once you’ve downloaded the code, upload the admin zip file to your server and extract it. The admin panel can be installed on either a domain or subdomain.

6.2.2 : Next, you’ll need to configure the following settings in your .env file: Database host, Database name, Database username, Database password, and your Firebase project credentials.

To obtain Firebase credentials, navigate to Project Settings > General > Web apps, then select your web app.

6.2.3 : Import the provided poolmate_admin_database.sql file to initialize the database.

6.2.4 : Now the admin panel is ready to run.

7. Landing Panel Setup

7.1. After downloading the source code, unzip poolmate_source_code.zip and upload the poolmate_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 panel setup (Recommended)

7.2. Update firebase credentials at .env file of landing panel site.

Now you can access your landing panel at your desired domain

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

8. Create Google Map API Key

8.1. Go to the Google Maps Platform

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

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

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

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

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

8.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.8. Click Create credentials and select API key. You will see a new dialog that displays the newly created API key.

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

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

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

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