ParcelFly - Deliveryman App Documentation

ParcelFly Documentation: This tab contains the deliveryman app documentation.

Getting Started

Introduction

The 'Parcel Fly Delivery' app revolutionizes parcel delivery and logistics support, providing a seamless platform for delivery personnel. Designed specifically for the delivery workforce, Parcel Fly Delivery offers an intuitive and user-friendly interface that streamlines parcel management from pickup to delivery. With Parcel Fly Delivery, delivery personnel can easily track parcels, manage assignments, and communicate with dispatchers and recipients. Comprehensive tools for real-time parcel tracking, and status updates enhance productivity and ensure timely deliveries. Whether you are handling multiple deliveries or a single route, Parcel Fly Delivery simplifies the complexities of logistics, making parcel delivery straightforward and efficient for all delivery personnel.

Microsoft Teams: [email protected]

WhatsApp: +8801811843300

Requirments

Flutter (Channel stable, 3.22.2, on Microsoft Windows [Version 10.0.22631.3737], locale en-US)
Flutter version 3.22.2
Upstream repository https://github.com/flutter/flutter.git
Framework revision 761747bfc5 (4 weeks ago) • 2024-06-05 22:15:13 +0200
Engine revision edd8546116
Dart version 3.4.3
DevTools version 2.34.3

Installation

Android Studio Installation(Windows)

Android Studio Installation(Mac)

Flutter Environment

Flutter Installation on Windows

Flutter Installation on Mac

If you have updated you mac to Catalina from mojavi or earlier version then you may fetch some issues.Please follow bellow video to fix it.

Get Started

Download and unzip the Flutter App, use your preferred IDE (Android Studio / Visual Code / IntelliJ) to open the project.
project/utils/urls.dart and edit the remote link to connect your mobile app with your admin panel

Go to /android/app/src/main/res/mipmap-hdpi and replace it with your logo or app icon.
Create your own Google Maps API key at https://cloud.google.com/maps-platform/.
Note: Follow the First 1 min to generate your own Google Maps API Key https://www.youtube.com/watch?v=9ImLCQBj9SE
Google Maps API Checker.
Please check your API before completing the installation http://yougapi.com/tools/google-api-key-checker.php
- If you see the message “Geocoding service ok” and a Map of NY with 3 markers, it means the Google API key is ready to be used in our store locator apps
- If you don’t see the image of the Map, make sure you have enabled the “static Maps” service from the “Enabled API” section

Android Configuration

Create your app icon ic_launcher and notification icon ic_notification folders How to generate an app icon? after you generate icons folder replace the following folders:

/mipmap-hdpi in /android/app/src/main/res/ folder
/mipmap-mdpi in /android/app/src/main/res/ folder
/mipmap-xhdpi in /android/app/src/main/res/ folder
/mipmap-xxhdpi in /android/app/src/main/res/ folder
/mipmap-xxxhdpi in /android/app/src/main/res/ folder

Get Dependencies

And just run the following command

flutter pub get

Change Package Name

If you want to change the package name following the next steps

Open /android/app/build.gradle and change the package name

defaultConfig {
                                  applicationId "" // this is the package name
                                  minSdkVersion 21
                                  targetSdkVersion 32
                                  versionCode flutterVersionCode.toInteger()
                                  versionName flutterVersionName
                                  testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
                              }

Open /android/app/src/main/AndroidManifest.xml , /android/app/src/profil/AndroidManifest.xml, /android/app/src/debug/AndroidManifest.xml and specify your:
- YOUR PACKAGE NAME
- YOUR PACKAGE NAME
- YOUR GOOGLE MAPS KEY

Open /android/app/src/main/kotlin/ /MainActivity.kt and change the package name
Copy the generated google-service.json file in /android/app/ folder, you can see this video tutorial How to configure push notifications?

User Guide

Splash

The splash screen appears when the deliveryman app starts. It shows the ParcelFly brand logo before loading the latest app settings, language terms, and theme configuration.

Onboarding

The onboarding screen introduces key delivery workflow benefits. Admin can manage the slider content from the web panel, and users can continue to the next slide or skip directly to authentication.

After creating a deliveryman account from the admin panel, the user can log in from this screen using either phone number or email together with the password. The same screen also provides direct access to the forgot password flow.

Forget Password

If the deliveryman forgets the password, they can enter the registered phone number or email here. The app resolves the account and sends the OTP to the registered email address for secure password recovery.

Otp Verification

After requesting password recovery, the deliveryman enters the OTP received in email and sets a new password. This screen completes the password reset process securely.

Dashboard

The dashboard gives a quick operational summary for the deliveryman. The next screenshots show the dashboard summary and the recent parcel view as separate sections.

Dashboard Summary

This view highlights the deliveryman profile shortcut, notification access, monthly earnings, collection, balance, and the live overview cards for parcel activity.

Dashboard Recent Parcels

This section of the dashboard focuses on recent parcel activity and gives quick access to parcel records from the home screen.

Deliveryman app dashboard recent parcel list

Parcels

The parcel module organizes assigned parcels by status. Each status view below is documented separately.

Pending Parcels

The pending parcel screen lists active assignments with customer details, invoice number, quantity, COD amount, tracking id, and a Details shortcut.

Delivered Parcels

The delivered parcel screen helps review completed delivery records using the same card layout for quick tracking and reference.

Partial Delivered Parcels

Partial delivery updates require extra input such as quantity and cash collection, making this flow distinct from a standard delivered update.

Parcel Details

The parcel details screen groups parcel information into sections such as parcel info, customer info, and merchant info so the deliveryman can verify everything before updating status.

Parcel Status Update

Parcel status update is a multi-step process. Each step below is separated for easier understanding.

Status Selection

In the first step, the deliveryman selects the new parcel status. Partial delivery can require extra quantity and cash collection fields.

Deliveryman app parcel status update dialog

OTP Confirmation

After requesting the update, the deliveryman confirms the action using the OTP provided by the customer.

Update Success Message

Once the OTP is verified, the app displays a success dialog confirming that the parcel status was updated correctly.

Deliveryman app parcel status success message dialog

Payments

The payment history module contains separate paid and unpaid commission views. Each screen is documented separately below.

Unpaid Commission

The unpaid commission view lists outstanding commission entries with date, tracking reference, amount, and a search option.

Paid Commission

The paid commission view shows completed commission payments so deliveryman can compare settled and pending transactions.

Language

This is a multi-language application. Admin can add or update language terms from the web panel, and deliveryman can switch the preferred app language from the profile screen.

Profile

The profile area contains account management tools. Each related screen is shown separately below for easier reference.

Profile Menu

The main profile menu provides access to language selection, profile details, change password, notifications, and logout.

Unread Notifications

Unread notifications are highlighted with a tinted background so new assignment and pickup alerts can be identified immediately.

Read Notifications

Read notifications use a clean white card style, helping deliveryman distinguish processed notifications from unread ones.

Update Profile

The update profile screen allows the deliveryman to change avatar, name, email, phone number, and address information.

Change Password

The change password screen requires the current password, new password, and confirmation password to update account security.

Logout Confirmation

Before logging out, the app shows a confirmation dialog so the deliveryman can cancel or confirm the action.

Run & Build

Run Android Application

In the target selector, select an Android device for running the app. If none are listed as available, select Tools> Android > AVD Manager and create one there. For details, see Managing AVDs. Click the run icon in the toolbar, or invoke the menu item Run > Run. Locate the main Android Studio toolbar:

If you don't use Android Studio or IntelliJ you can use the command line to run your application using the following command

                        
                          flutter run

Build And Install App

After you make all your changes and customizations save all your project, Open the console, navigate to your project folder and execute the following command to build your app flutter build apk --release
If you are deploying the app to the Play Store, it's recommended to use app bundles or split the APK to reduce the APK size.
To generate an app bundle, run: flutter build appbundle --target-platform android-arm,android-arm64,android-x64
Learn more on https://developer.android.com/guide/app-bundle
To split the APKs per ABI, run: flutter build apk --target-platform android-arm,android-arm64,android-x64 --split-per-abi
Learn more on https://developer.android.com/studio/build/configure-apk-splits#configure-abi-split
You should get the APK file in the build/output/apk folder, to install your application on your connected device run the following command