HireMe User App - Documentation

Introduction

Welcome to the official documentation for the HireMe User App. This guide is designed to help you understand the product structure, installation requirements, customization options, and core user-facing features included in the application package.

The HireMe User App is built for customers who want to book a professional driver for their own vehicle, making it suitable for personal travel, city rides, business trips, and scheduled transport services.

Features

• Clean and intuitive user registration and sign-in flow.
• Secure password recovery and OTP verification screens.
• Driver search and booking interface with modern mobile UI.
• Booking confirmation and completion workflow.
• Location-based ride experience tailored for user convenience.
• Well-structured Flutter codebase for easy branding and extension.

Requirements & Installation

For the smoothest setup experience, it is recommended to use the same development environment versions used during testing. Matching the versions below helps reduce compatibility issues during build and deployment.

Requirements

• Flutter: 3.41.4 and Dart: 3.11.1
• Java: 17.0.12
• Android SDK: Latest stable version

Installation Steps

1. Install the latest Flutter SDK from the official website: Flutter installation guide.
2. Install JDK 17 from Oracle: JDK 17 download.
3. Install Android Studio and the required Android SDK tools: Android Studio download.
4. Extract the downloaded CodeCanyon package and open the `UserApp` folder in Android Studio or your preferred IDE.

Configuration

After installation, you can customize the application to match your brand identity and backend setup.

Change App Colors

Open lib/core/constants/constants.dart. In the AppColors class, update the predefined color values to reflect your brand palette.

Update API Routes

In lib/core/constants/constants.dart, locate the ApiConfig class and replace the existing endpoint constants with your production or staging API URLs.

Change the App Name

Update the appName constant in lib/core/constants/constants.dart, then open android/app/src/main/AndroidManifest.xml and change the android:label value to your preferred brand name.

Replace the App Icon

Navigate to android/app/src/main/res and replace the launcher icons in each density folder. If needed, you can generate Android icon sizes using Easy App Icon.

Support

If you need assistance with setup or customization, please submit a ticket through the Support Portal. Be sure to include relevant screenshots and error details for faster resolution.

Changelog

This release marks the initial public version of the application package.

Version Info

• v1.0.0 - Initial release (latest).