Introduction

Welcome to Handy2home, a powerful B2B on-demand appliance and home services platform built to help businesses efficiently manage repair, installation, and maintenance operations at scale. The platform enables enterprises, property managers, facility teams, and service providers to connect with verified technicians and authorized service partners through a centralized digital system.

Core Features

• Book Home Service
• Order Tracking
• Service Partner Module
• Custom Service Options
• Smart Service Search
• Multiple Service Types
• Booking Management
• Support & Queries
• Flexible Scheduling
• Service Dashboard
• Referral System
• Payment Integration
• Wallet Payment (Full or Partial)
• Partner Auto-Cancel Logic
• Service Partner KYC Verification

New Features

Getting Started

hub Third Party Services

dns Environmental Setup

System Requirements

Operating System:

• Windows 10/11 (64-bit) - Pro or Enterprise recommended
• macOS Monterey (12.0) or later (Sonoma 14.5+ recommended)
• Linux (Ubuntu 20.04 LTS, 22.04 LTS, or equivalent)

Minimum Hardware:

• Processor: Intel i5 10th Gen (or AMD Ryzen 5) or better
• RAM: 8 GB (minimum), 16 GB recommended for Android Studio
• Storage: 2 GB free disk space for dependencies, SDKs, and build files
• Internet: Broadband connection required for downloading dependencies

Software Requirements

XAMPP Installation

1. Download XAMPP from apachefriends.org (version 8.2+ recommended)
2. Install XAMPP on your system with default settings
3. After installation, start Apache and MySQL services from the XAMPP control panel
4. Verify installation by visiting http://localhost in your browser

Composer Installation

1. Download Composer from getcomposer.org
2. Run the installer and follow the setup wizard
3. Ensure Composer is added to your system PATH
4. Verify installation: composer --version (should show 2.5+)

memory Technology Stack

view_module Project Dependencies

Core Libraries

These libraries provide the core framework functionality and handle state management, navigation, API communication, and date processing.

Navigation Libraries

These libraries handle screen navigation, routing, and tab management within the applications.

Maps and Location

These libraries enable map rendering and location tracking within the application.

Firebase Services

Firebase is integrated to support real-time notifications and data synchronization.

UI and Animation Libraries

These libraries enhance the user interface and animation experience.

Device Features

These libraries enable the application to interact with native device capabilities.

Payment Integration

The application integrates multiple payment gateways to support secure online transactions.

Additional Libraries

Additional utility libraries used across the applications.

Customer-Only Libraries

These libraries are specific to the Customer application.

person Customer Application Guide

How Customers Use the Application

build Partner Application Guide

Partner App Workflow

admin_panel_settings Admin Panel Guide

Admin Panel Overview

Key Admin Workflows

android Android Configuration

Build Configuration

File Location: android/build.gradle

Gradle Plugin Configuration

admin_panel_settings Admin Configuration

System Requirements

Before installing, ensure your server meets these requirements:

Installation Steps

1. 1

   Extract Source Code

   Extract the downloaded package. You will find two folders: Admin/ (Laravel backend) and Frontend/ (React).

2. 2

   Move to XAMPP

   Copy both folders into xampp/htdocs/

   info

   Example: xampp/htdocs/Admin and xampp/htdocs/Frontend

Backend (Laravel) Configuration

1. 3

   Open Terminal in Admin Folder

   cd C:\xampp\htdocs\Admin

   content_copy
2. 4

   Install Laravel Dependencies

   Run Composer install:

   composer install

   content_copy

   If Composer is not installed, download from getcomposer.org

3. 5

   Copy Environment File

   If .env doesn't exist, create from example:

   cp .env.example .env (Linux/Mac) or copy .env.example .env (Windows)

   content_copy
4. 6

   Configure .env File

   Open Admin/.env and update these values:

   Application Settings

   APP_NAME=YourAppName
APP_ENV=local
APP_DEBUG=true
APP_URL=your-api-url
IMG_URL=your-api-url/public/uploads/
APP_MODE=DEMO

   content_copy

   Database Configuration

   DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=your_database_name
DB_USERNAME=your_db_username
DB_PASSWORD=your_db_password

   content_copy

   Mail Configuration

   MAIL_HOST=smtp.yourmail.com
MAIL_PORT=587
MAIL_USERNAME=your_email@example.com
MAIL_PASSWORD=your_email_password
MAIL_ENCRYPTION=tls
MAIL_FROM_ADDRESS="your_email@example.com"
MAIL_FROM_NAME="${APP_NAME}"

   content_copy

   RouteMappy (instead of Google Maps)

   ROUTEMAPPY_API_KEY=your_routemappy_api_key
ROUTEMAPPY_BASE_URL=https://api.routemappy.com/v1

   content_copy

   RouteMappy provides mapping, directions, geocoding, and distance matrix services.

   Firebase Configuration

   Firebase is required for push notifications, real-time database features, and other Firebase services. Before using the application, configure your own Firebase project.

   Step 1: Download Firebase Service Account

   1. Open the Firebase Console.
   2. Select your Firebase Project.
   3. Go to Project Settings → Service Accounts.
   4. Click "Generate New Private Key".
   5. A JSON file will be downloaded (Example: your-app-name-firebase-adminsdk.json).

   Step 2: Upload the JSON File

   Copy the downloaded Firebase JSON file into the following directory:

   Admin/config/your-app-name.json

   content_copy

   Step 3: Update the .env File

   FIREBASE_FILE=your-app-name.json FIREBASE_DB=https://your-project.firebaseio.com FCM_SERVER_KEY=your_fcm_server_key FCM_SENDER_ID=your_fcm_sender_id

   content_copy

   check_circle

   Firebase Connected

   Once the JSON file is uploaded and the .env values are updated, the application will automatically connect to your Firebase project.

   shield

   Security Notice

   Never share your Firebase Service Account JSON file or upload it to a public Git repository. This file contains sensitive credentials with administrative access to your Firebase project.

   Twilio SMS Configuration

   TWILIO_SID=your_twilio_sid
TWILIO_TOKEN=your_twilio_token
TWILIO_FROM=+1234567890

   content_copy

   Required only if SMS verification is enabled.

   Mode Setting

   MODE=DEMO

   content_copy

   Set to LIVE for production mode.

5. 7

   Create Database

   Open http://localhost/phpmyadmin and create a new database.

   info

   Example: your_database — Use the same name as DB_DATABASE in your .env file.

6. 8

   Import Database

   Import the SQL file from Admin/database/database.sql using phpMyAdmin.

   info

   The SQL file contains all required tables and initial data.

7. 9

   Generate Application Key

   php artisan key:generate

   content_copy

   This command generates a unique application key that is used for encryption and security purposes.

8. 10

   Run Migrations

   php artisan migrate

   content_copy
9. 11

   Seed the Database

   php artisan db:seed --force

   content_copy

   The --force flag is used to run the seeder in production environments. For local development, you can omit it.

10. 12

    Generate Shield Permissions

    Run the following command to generate all Shield permissions:

    php artisan shield:generate --all --option=permissions --panel=admin

    content_copy

    After generating permissions, run this command to assign the super admin role to your admin user:

    php artisan tinker --execute=" \$role = DB::table('roles')->where('name','super_admin')->first(); \$perms = DB::table('permissions')->pluck('id')->toArray(); \$rows = array_map(fn(\$id) => ['permission_id'=>\$id,'role_id'=>\$role->id], \$perms); DB::table('role_has_permissions')->insertOrIgnore(\$rows); DB::table('model_has_roles')->insertOrIgnore(['role_id'=>1,'model_type'=>'App\\\Models\\\User','model_id'=>1]); echo 'Done: Admin assigned to super_admin role'; "

    content_copy

    This generates all necessary permissions and assigns the super_admin role to the admin user (ID: 1).

11. 13

    Create Storage Link

    php artisan storage:link

    content_copy

    This command is required for image uploads to work properly.

12. 14

    Clear Cache

    php artisan optimize:clear

    content_copy

    Or run individually: php artisan config:clear, php artisan cache:clear, php artisan route:clear, php artisan view:clear

13. 15

    Start Laravel Server

    php artisan serve

    content_copy

    Laravel will run on http://127.0.0.1:8000

Admin Frontend (React) Configuration

1. 16

   Open Frontend Folder

   cd D:\Frontend

   content_copy
2. 17

   Install Dependencies

   npm install

   content_copy
   info

   Troubleshooting: If npm fails, delete node_modules and package-lock.json, then run npm install again.
3. 18

   Install Missing Packages (If Needed)

   Sometimes npm may report missing packages. Install them individually:

   npm install react-router-dom
npm install chart.js
npm install react
npm install react-chartjs-2
npm install react-dom
npm install react-toastify
npm install axios
npm install firebase
npm install lucide-react


   content_copy
4. 19

   Frontend Environment Variables

   If your project includes .env file, update these values:

   VITE_APP_NAME=Your App Name
VITE_API_ORIGIN=your-api-url


   content_copy
5. 20

   Start React Development Server

   npm run dev

   content_copy

   React will run on http://localhost:5173 (or the port shown in terminal).

Login Credentials

Use these default credentials to log in to the admin panel:

Common Installation Issues

Production Checklist

System Requirements

Before installing, ensure your system meets these requirements:

Project Structure

Installation Steps

1. 1

   Extract the Project Files

   Extract the downloaded ZIP file to your desired location.

   info

   Recommended: Extract to ~/Projects/Handy2home_landing_page/
2. 2

   Open Terminal in Project Folder

   cd path/to/Handy2home_landing_page

   content_copy
3. 3

   Install Dependencies

   Run npm install to install all required packages:

   npm install

   content_copy
4. 4

   Start Development Server

   Launch the development server:

   npm run dev

   content_copy

   The application will be available at http://localhost:5173

   Admin Panel Access: http://localhost:5173/admin

Admin Panel Guide

Admin Panel Sections

Available Scripts

Deployment Guide

1. Build for Production

This creates a dist/ folder with optimized files.

2. Deploy to Hosting

• Vercel: npx vercel --prod
• Netlify: Drag and drop the dist/ folder
• GitHub Pages: Deploy with npm run build and commit
• AWS S3: Upload the dist/ folder to S3 bucket
• Traditional Hosting: Upload via FTP to public_html

Common Issues & Solutions

Deployment Checklist

phone_android Mobile App Configuration

Step 1: Install Node.js

Download and install Node.js from your browser by visiting the official website: https://nodejs.org/en/download

Step 2: Install Android Studio

Download and install Android Studio on your system from: https://developer.android.com/studio

Customer App Configuration

Step 1: Copy App Folder

Copy the customer folder and paste it into your desired location.

Step 2: Change the Bundle ID

For Android, open:

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

Change the package attribute to your new bundle ID, for example:

For iOS, open:

folder_open ios/CustomerApp.xcodeproj

Update the Bundle Identifier under the app's target settings in Xcode.

app_registration App Name & Icon

Changing App Name

folder_open Handy2home/android/app/src/main/res/values/strings.xml

Changing App Icon

1. Replace all icon files in res/mipmap-* directories
2. Update adaptive icons in res/mipmap-anydpi-v26
3. Rebuild your app

package Package Name

Android Configuration

folder_open Handy2home/android/app/build.gradle

construction Custom Work

If you need additional features, modifications, or integrations in this application, we offer custom development services to tailor the app to your specific needs.

For any custom work requests, please get in touch with us:

• language Website: https://menpanitech.com/
• mail Email: sales@menpanitech.com

history Version History

local_fire_department Firebase Configuration

Admin Panel Configuration

Project Setup

• Go to Firebase Console and create a new project
• Create a web app in your Firebase project

Database Configuration

• Navigate to your project dashboard and create the Database

Service Account Setup

• Go to Settings → Project settings → Advanced permissions settings
• Click on "Service Accounts" under Firebase Admin SDK section
• Click "Actions" → "Manage Keys" → "Add Key" → "Create new key"
• Select JSON format and click "Create"

.env Configuration

Mobile App Configuration

Android Setup

• Select your existing project in Firebase Console
• Click Settings icon → Project settings → Add app → Android
• Download google-services.json file
• Place the file in: Handy2home_customer/android/app

Required Firebase Services

fingerprint Bundle ID

Clients must update the bundle identifier to match their application package.

Example: com.clientname.Handy2home

Android

Update in:

folder_open android/app/build.gradle

Rename the Java package directory:

folder_open android/app/src/main/java/com/clientname/Handy2home

key Keystore Configuration

Generate a signing keystore:

Place the keystore file inside:

folder_open android/app/

Update the signing configuration in:

folder_open android/gradle.properties

rocket_launch Android Release Build

Generate APK

APK location: android/app/build/outputs/apk/release/app-release.apk

Generate Play Store Bundle

Output: android/app/build/outputs/bundle/release/app-release.aab

phone_iphone iOS Configuration

iOS development requires a macOS system with Apple Xcode installed. Xcode provides all necessary tools, simulators, and SDKs required to build and run the application on iOS devices.

Ensure that you have the latest version of Xcode installed from the Mac App Store and have accepted all license agreements before proceeding.

download Install iOS Dependencies

The iOS project uses CocoaPods to manage native dependencies. You must install all required pods before running the application.

Follow the steps below:

This command installs all required native libraries and links them with your iOS project.

local_fire_department iOS Firebase Setup

Firebase is used for push notifications and other backend services. You need to download and configure the Firebase iOS configuration file.

Step 1: Download Configuration File

GoogleService-Info.plist

Step 2: Add File to Project

Place the downloaded file inside the following directory:

folder_open ios/Handy2home/GoogleService-Info.plist

Steps in Xcode:

1. Open the iOS project in Xcode.
2. Drag and drop the GoogleService-Info.plist file into the Project Navigator.
3. Select "Copy items if needed" when prompted.
4. Ensure the file is added to the main application target.

This configuration enables Firebase services such as push notifications and analytics.

fingerprint iOS Bundle Identifier

The Bundle Identifier uniquely identifies your application in the Apple ecosystem. It must match the identifier configured in Firebase and Apple Developer account.

Steps:

1. Open the project in Xcode: ios/Handy2home.xcworkspace
2. Select the main application target.
3. Go to the General tab.
4. Update the Bundle Identifier field.

Example: com.clientname.homeserviceapp

Ensure that the Bundle Identifier matches exactly with the one used in the Firebase configuration file, otherwise services may not work correctly.

image iOS App Icons

Application icons are used across the app, App Store, and device home screen. You need to replace the default icons with your branding assets.

App Icon Path:

folder_open ios/Handy2home/Images.xcassets/AppIcon.appiconset

Replace all icon sizes inside this folder with your custom icons while maintaining the required dimensions.

iOS App Logo

Replace the main logo used inside the application UI:

folder_open src/assets/logo.png

Recommended size: 500 × 500 PNG (transparent background preferred)

play_arrow Run iOS Application

Before running the application, make sure the Metro bundler is running.

Step 1: Start Metro Server

Step 2: Run iOS App

This command will build the app and launch it in the iOS Simulator. Alternatively, you can open the project in Xcode and run it directly on a simulator or a physical device.

rocket_launch iOS Release Build

To publish your application to the App Store, you must generate a release build using Xcode.

Steps:

1. Open the project in Xcode: ios/Handy2home.xcworkspace
2. Select Generic iOS Device as the build target.
3. From the top menu, select Product → Archive.
4. Once the archive is created, open the Organizer window.
5. Validate and upload the build to App Store Connect.

After uploading, you can manage your app release from App Store Connect.

api API Configuration

Application API configuration is located in:

folder_open src/config/const.js

Update the following values with client server details:

• BASE_URL
• API_URL
• IMG_URL
• SOCKET_URL (if applicable)

Example:

palette Branding Configuration

Application Logo

Replace the logo file located at:

folder_open src/assets/logo.png

Recommended format: 500 × 500 PNG

Android Launcher Icons

Replace launcher icons in:

folder_open android/app/src/main/res/

Folders:

• mipmap-mdpi
• mipmap-hdpi
• mipmap-xhdpi
• mipmap-xxhdpi
• mipmap-xxxhdpi

iOS App Icons

Replace icons in:

folder_open ios/Handy2home/Images.xcassets/AppIcon.appiconset

map Map Provider

The application uses MapLibre for map rendering and location-based services.

Map Library Used

Capabilities

These features enable the application to display technician locations, service routes, and navigation paths within the app.

route RouteMappy

Admin Panel Configuration

Step 1: Enter Your RouteMappy API Key

In the place of enter_map_key in your .env file, add your RouteMappy API key as shown below:

Mobile Application Configuration

Step 1: Add Your API Key

Edit the following file:

folder_open Handy2home/src/config/Constants.js

payments Payment Integration

Library Used

• react-native-razorpay
• flutterwave-react-native

Features

Configuration

Payment credentials must be configured on the backend server to enable transaction processing.

Required credentials typically include:

• Payment Gateway API Key
• Secret Key
• Webhook configuration for transaction validation

These credentials are used by the backend API to securely communicate with the payment gateway.

notifications FCM Configuration

Modern FCM v1 Setup (OAuth 2.0)

This guide covers the modern Firebase Cloud Messaging v1 API. It uses OAuth 2.0 for secure authentication and provides more features than the deprecated legacy API.

Step 1: Generate Service Account Credentials

1. Access Firebase Console

   Go to Firebase Console and select your project.

   Navigate to Project Settings (gear icon) → Service accounts tab.

   
2. Generate a new private key

   Click "Generate new private key" in the Firebase Admin SDK section.

   Confirm by clicking "Generate key" in the popup.

   A JSON file (your-project-id-firebase-adminsdk.json) will be downloaded automatically. This file contains your service account credentials.

   shield Security Keep this file secure. It contains sensitive credentials that provide full access to your Firebase services. Never commit this file to a public repository or share it with unauthorized users.

Step 2: Server-Side Configuration

Place the Service Account File

Copy the downloaded JSON file to your project's secure configuration directory:

Configure Environment Variables

Update your backend .env file with the following configuration:

Step 3: Sending Notifications with v1 API

Here's a secure implementation example for sending push notifications using the FCM v1 API with OAuth 2.0 authentication:

Troubleshooting

mail Gmail Configuration

Step-by-Step Configuration

1. Step 1: Access Gmail Account Settings

   Log in to your Gmail account and click on your profile picture in the top right corner. Select "Manage your Google Account" from the dropdown menu.

   

2. Step 2: Enable Security Verification

   Navigate to the "Security" tab in the left sidebar.

   

   Under "Signing in to Google," enable 2-Step Verification if not already active.

   
   info

   Note: You must have 2-Step Verification enabled to generate an App Password.

3. Step 3: Generate App Password

   While still in the Security section:

   1. Find the "App passwords" option (under 2-Step Verification)

      

   2. Click "create"

      

   3. Copy the 16-character password shown

      

.env File Configuration

Add these configurations to your .env file:

Troubleshooting

devices Device Configuration

Application Deployment Guide

Environment Setup

1. Connect your device via USB
2. Verify connection:

Confirm the device appears in the list.

Build & Run Process

1. Launch Command Prompt
2. Navigate to project directory:

3. Install project dependencies:

4. Execute the application:

help_outline FAQ & Troubleshoot

FAQ & Troubleshooting

support_agent Contact Us

Custom Development Services

If you need any custom work, additional features, or modifications to this application, our team is ready to help you build and scale your project efficiently.

What We Can Help With

Hire Us

You can hire our development team for complete project development, from idea to deployment, including frontend, backend, and server setup.