FoodPilotPro — Documentation

📖

Introduction

FoodPilotPro is a complete multi-platform restaurant management system consisting of three interconnected applications:

⚡

Admin Panel

Laravel backend API + admin dashboard for restaurant owners and managers.

▲

Customer Web App

Next.js web application for customers to browse menus and place orders.

🐦

Mobile App

Flutter app for Android & iOS — full ordering experience on mobile.

All three apps communicate through the Laravel REST API. Follow this documentation to install and configure each component in the correct order.

🏗️

System Architecture

All platforms connect to one Laravel REST API. Install the API first before configuring the web or mobile apps.

▲ Next.js App

← REST →

⚡ Laravel API

← REST →

🐦 Flutter App

Replace with actual architecture diagram image

What's Included

✓ Laravel API source code
✓ Next.js customer web app
✓ Flutter mobile app (Android + iOS)
✓ Postman API collection
✓ Documentation

Tech Stack

• PHP 8.2+ / Laravel 11
• Node.js 18+ / Next.js 14
• Flutter 3.x / Dart
• MySQL 5.7+ / MariaDB

✅

Server Requirements

Verify your hosting environment before installation.

PHP & Extensions

✓ PHP 8.2 or higher
✓ OpenSSL
✓ PDO Extension
✓ Mbstring Extension
✓ Tokenizer Extension
✓ XML Extension
✓ JSON Extension
✓ GD / Imagick
✓ Fileinfo Extension
✓ CURL Extension

Database & Server

✓ MySQL 5.7+ or MariaDB
✓ Composer 2.x
✓ Apache or Nginx
✓ SSL Certificate (HTTPS)
✓ 512MB+ RAM
✓ SSH or Terminal access

🚀

Installation Guide

Deploy the Laravel backend on your server step by step.

1

Download from Envato

Log in to your CodeCanyon account → Downloads → FoodPilotPro → Download All Files & Documentation. Extract the ZIP locally.

2

Create API Subdomain

From cPanel / DirectAdmin, create a subdomain and point it to your API folder:

api.yourdomain.com  →  public_html/api

3

Upload Backend Files

Upload laravel-backend.zip into the API folder via File Manager or FTP, then extract it.

4

Create MySQL Database

cPanel → MySQL Database Wizard → create a new database, user, and assign All Privileges. Save credentials for the next step.

5

Configure .env File

Copy .env.example → .env and fill in your values:

APP_NAME=FoodPilotPro
APP_ENV=production
APP_DEBUG=false
APP_URL=https://api.yourdomain.com

DB_CONNECTION=mysql
DB_HOST=localhost
DB_PORT=3306
DB_DATABASE=your_database
DB_USERNAME=your_username
DB_PASSWORD=your_password

MAIL_MAILER=smtp
MAIL_HOST=smtp.mailtrap.io
MAIL_PORT=587
MAIL_USERNAME=your_email
MAIL_PASSWORD=your_password
MAIL_FROM_ADDRESS=no-reply@yourdomain.com

6

Run Artisan Commands

Via SSH terminal or hosting terminal:

composer install --optimize-autoloader --no-dev
php artisan key:generate
php artisan migrate --force
php artisan db:seed --force
php artisan storage:link
php artisan config:cache
php artisan route:cache
php artisan optimize

7

Set Folder Permissions

chmod -R 775 storage bootstrap/cache
chown -R www-data:www-data storage bootstrap/cache

✓

Test the API

Import the included Postman collection and test GET /api/health. You should receive a 200 OK response.

⚠️

Important: Ensure storage link is created, folder permissions are correct, and APP_DEBUG=false in production to prevent exposing sensitive data.

⚙️

Admin Configuration

Default Admin Credentials

Email:    admin@foodpilotpro.com
Password: password

Change these immediately after first login.

Pusher — Real-time Notifications (Optional)

BROADCAST_DRIVER=pusher
PUSHER_APP_ID=your_app_id
PUSHER_APP_KEY=your_app_key
PUSHER_APP_SECRET=your_app_secret
PUSHER_APP_CLUSTER=mt1

Firebase Push Notifications (Optional)

FIREBASE_PROJECT_ID=your_project_id
FIREBASE_SERVER_KEY=your_server_key

✨

Admin Panel Features

Overview of the Laravel admin dashboard capabilities. Replace placeholders with actual screenshots.

📊 Analytics Dashboard

Add screenshot here
./image/admin/dashboard.png

📊 Overview

Analytics Dashboard

Real-time bird's-eye view of your restaurant performance with key business metrics and sales data.

✓ Daily, weekly, monthly revenue charts
✓ Total orders and completion rate
✓ Top-selling menu items ranking
✓ Recent order activity feed
✓ New customer growth graph

🍽️ Menu Management

Add screenshot here
./image/admin/menu.png

🍽️ Menu

Menu Management

Full control over your food catalog with rich media support and real-time availability management.

✓ Add/edit items with images and descriptions
✓ Organize by categories and subcategories
✓ Set prices, discounts, and add-ons
✓ Toggle item availability instantly
✓ Manage variants and portion options

📦 Order Management

Add screenshot here
./image/admin/orders.png

📦 Orders

Order Management

Process, track, and manage every order from a single streamlined interface with real-time updates.

✓ Real-time incoming order notifications
✓ Status pipeline: pending → confirmed → delivered
✓ Assign orders to delivery drivers
✓ Itemized order detail view
✓ Export order reports as CSV

👥 User Management

Add screenshot here
./image/admin/users.png

👥 Users

User & Role Management

Manage all platform users with granular role-based access control and full activity oversight.

✓ Customer accounts and order history
✓ Delivery driver profiles and assignments
✓ Admin roles with permission levels
✓ Suspend / activate accounts instantly
✓ User activity and login logs

🏪 Restaurant Settings

Add screenshot here
./image/admin/settings.png

🏪 Settings

Restaurant Settings

Configure every aspect of your restaurant operation from one centralized settings panel.

✓ Operating hours and holiday schedules
✓ Delivery zones and radius configuration
✓ Payment method on/off toggles
✓ Multiple branch / location management
✓ Tax, VAT, and delivery fee settings

🎟️ Promotions & Coupons

Add screenshot here
./image/admin/promos.png

🎟️ Promotions

Promotions & Coupons

Run targeted promotions and discount campaigns to boost sales and improve customer retention.

✓ Percentage and flat-amount discount codes
✓ Coupon code generation and management
✓ Expiry dates and per-user usage limits
✓ Minimum order value rules
✓ Homepage banner promotion slots

💡

Replace each placeholder <div> with <img src="./image/admin/NAME.png" class="w-full h-full object-cover" />.

✅

Requirements

Development Machine

✓ Node.js 18.x or higher
✓ npm 9+ or Yarn 1.22+
✓ Git

Hosting

✓ VPS with Node.js, or
✓ Vercel / Netlify (recommended)
✓ SSL Certificate

🚀

Installation Guide

1

Extract & Install Dependencies

cd nextjs-client
npm install

2

Configure Environment

Copy .env.example → .env.local:

NEXT_PUBLIC_API_URL=https://api.yourdomain.com
NEXT_PUBLIC_APP_NAME=FoodPilotPro
NEXT_PUBLIC_APP_URL=https://yourdomain.com

# Google Maps (delivery tracking)
NEXT_PUBLIC_GOOGLE_MAPS_KEY=your_google_maps_api_key

# Payment Gateway
NEXT_PUBLIC_STRIPE_KEY=pk_live_xxxxxxxxxxxx
STRIPE_SECRET_KEY=sk_live_xxxxxxxxxxxx

3

Run Development Server

npm run dev
# Opens at http://localhost:3000

4

Build for Production

npm run build
npm run start

▲

Deploy to Vercel (Recommended)

npm i -g vercel
vercel login
vercel --prod

Add env variables in Vercel → Project → Settings → Environment Variables.

⚙️

Client Configuration

App Branding Config

// src/config/app.ts
export const APP_CONFIG = {
  name: "FoodPilotPro",
  tagline: "Order food online",
  logo: "/assets/logo.png",
  primaryColor: "#f98819",
};

Replace Logo & Favicon

/public/logo.png — Main logo
/public/favicon.ico — Browser tab icon
/public/og-image.png — Social share image (1200×630px)

✨

Client App Features

Key screens of the Next.js customer web application.

🏠 Homepage

Add screenshot here
./image/client/homepage.png

🏠 Homepage

Dynamic Homepage

The first thing customers see — designed to drive engagement with promotions and fast food discovery.

✓ Hero banner with custom promotions
✓ Featured restaurant listings
✓ Quick category navigation bar
✓ Top-rated food items grid
✓ Search bar with instant results

🍕 Menu & Categories

Add screenshot here
./image/client/menu.png

🍕 Menu

Menu & Categories

Clean, fast browsing experience for customers to explore the full menu with smart filtering.

✓ Category and subcategory filtering
✓ Search by food name or ingredient
✓ Dietary badges (Vegan, Halal, Spicy)
✓ Food item detail modal with images
✓ Add to cart with custom options

🛒 Cart & Checkout

Add screenshot here
./image/client/checkout.png

🛒 Checkout

Cart & Checkout

Frictionless checkout flow from cart review to payment confirmation in just a few taps.

✓ Cart item management and quantities
✓ Apply coupon codes
✓ Saved delivery address selection
✓ Multiple payment methods
✓ Order summary and total breakdown

📍 Order Tracking

Add screenshot here
./image/client/tracking.png

📍 Tracking

Real-Time Order Tracking

Customers can follow their order every step of the way with live map and status updates.

✓ Step-by-step order status timeline
✓ Live map with driver location
✓ Estimated arrival time
✓ Push notification updates
✓ Contact driver option

👤 User Profile

Add screenshot here
./image/client/profile.png

👤 Profile

Customer Profile

A personalized space for customers to manage their account, orders, and preferences.

✓ Edit profile and contact information
✓ Manage saved delivery addresses
✓ Full order history with reorder
✓ Wallet balance and top-up
✓ Notification preferences

🔐 Authentication

Add screenshot here
./image/client/auth.png

🔐 Auth

Authentication Flow

Secure, smooth sign-up and login experience with OTP phone verification and social login options.

✓ Email and phone registration
✓ OTP-based phone verification
✓ Social login (Google, Facebook)
✓ Forgot password with email reset
✓ Remember device for quick login

💡

Replace each placeholder <div> with <img src="./image/client/NAME.png" class="w-full h-full object-cover" />.

🔗

Base URL Setup

Connect the Flutter app to your deployed Laravel API.

// lib/utils/app_constant.dart
class AppConstant {
  static const String baseUrl = "https://api.yourdomain.com";
  static const String appName = "FoodPilotPro";
}

⚠️

Base URL must point to the API subdomain, not the web app domain. No trailing slash.

✏️

Change App Name

1. Flutter constant

// lib/utils/app_constant.dart
static const String appName = "YourAppName";

2. Android

// android/app/src/main/AndroidManifest.xml
android:label="YourAppName"

3. iOS

// ios/Runner/Info.plist
<key>CFBundleName</key>
<string>YourAppName</string>

📦

Change Package Name

Update Android namespace globally before publishing.

// android/app/build.gradle
android {
  namespace = "com.yourcompany.yourapp"
  defaultConfig {
    applicationId = "com.yourcompany.yourapp"
  }
}

Global Find & Replace

Windows/Linux: Ctrl+Shift+R macOS: ⌘+Shift+R

Verify these files after replacement:

android/app/build.gradle
android/app/src/main/AndroidManifest.xml
android/app/src/debug/AndroidManifest.xml
android/app/src/main/java/ (or kotlin/)

flutter clean && flutter pub get && flutter run

🎨

Change App Icon

Generate icon sets and replace for both platforms.

Generate all sizes with appicon.co — upload a 1024×1024 PNG and download all sizes.

🤖 Android

/android/app/src/main/res/

🍎 iOS

/ios/Runner/Assets.xcassets/

flutter clean && flutter pub get && flutter run

🤖

Build for Android

Release APK

flutter build apk --release
# Output: build/app/outputs/flutter-apk/app-release.apk

Split APKs (smaller download size)

flutter build apk --target-platform android-arm,android-arm64,android-x64 --split-per-abi

AAB — Google Play Store

Create signing keystore:

# macOS/Linux
keytool -genkey -v -keystore ~/upload-keystore.jks \
  -keyalg RSA -keysize 2048 -validity 10000 -alias upload

# Windows PowerShell
keytool -genkey -v -keystore $env:USERPROFILE\upload-keystore.jks `
  -storetype JKS -keyalg RSA -keysize 2048 -validity 10000 -alias upload

Create android/key.properties:

storePassword=your_store_password
keyPassword=your_key_password
keyAlias=upload
storeFile=../upload-keystore.jks

Build:

flutter build appbundle
# Output: build/app/outputs/bundle/release/app-release.aab

🍎

Build for iOS

⚠️

Requires macOS with Xcode 14+ and an active Apple Developer account ($99/year).

1

Create Certificate Signing Request

Keychain Access → Certificate Assistant → Request a Certificate from a Certificate Authority → Save to disk.

2

Create iOS Distribution Certificate

Apple Developer portal → Certificates, IDs & Profiles → Create iOS Distribution certificate using your CSR file.

3

Open in Xcode

open ios/Runner.xcworkspace

Set Bundle Identifier, Version, Team, and Signing Certificate in target settings.

4

Build & Archive

flutter build ipa

Then: Xcode → Product → Archive → Distribute App → App Store Connect → Upload.

✨

Mobile App Features

Key screens of the Flutter app — Android & iOS. Replace placeholders with actual device screenshots.

🏠 Home Screen

./image/mobile/home.png

🏠 Home

Home Screen

The app's landing screen — fast food discovery with promotions, categories, and featured items.

✓ Promotional banners carousel
✓ Category quick-select row
✓ Featured and recommended items
✓ Search bar with suggestions
✓ Location-aware restaurant listings

🍕 Food Menu

./image/mobile/menu.png

🍕 Menu

Food Menu

Rich browsing experience with search, filters, and detailed food item views — all in native mobile speed.

✓ Browse by category tabs
✓ Search by food name or keyword
✓ Dietary and allergy filters
✓ Item detail screen with add-ons
✓ Quantity selector and notes

🛒 Cart

./image/mobile/cart.png

🛒 Cart

Cart

Clear cart review screen with inline editing before the customer proceeds to checkout.

✓ Item list with swipe-to-delete
✓ Inline quantity adjustments
✓ Subtotal and delivery fee breakdown
✓ Coupon code entry field
✓ Proceed to checkout button

💳 Checkout

./image/mobile/checkout.png

💳 Checkout

Checkout

Single-screen checkout flow — address, payment method, and order confirmation in one place.

✓ Saved and new delivery addresses
✓ Payment method selection
✓ Order notes / special instructions
✓ Final total with taxes
✓ Place order confirmation button

📍 Live Tracking

./image/mobile/tracking.png

📍 Tracking

Live Order Tracking

Full-screen map view with real-time driver location and animated order status progression.

✓ Live driver location on map
✓ Animated status steps
✓ Estimated time of arrival
✓ Push notification at each status change
✓ Contact driver / support button

📋 Order History

./image/mobile/orders.png

📋 Orders

Order History

Full history of past orders with reorder in one tap and detailed receipt view per order.

✓ Paginated order history list
✓ Order status badge per item
✓ Detailed receipt / invoice view
✓ One-tap reorder button
✓ Rate and review after delivery

👤 Profile

./image/mobile/profile.png

👤 Profile

Profile & Account

Centralized account screen where users manage personal info, addresses, and preferences.

✓ Edit name, phone, and avatar
✓ Manage saved delivery addresses
✓ Wallet balance and transactions
✓ App language and notification settings
✓ Logout and account deletion

🔔 Notifications

./image/mobile/notif.png

🔔 Notifications

Push Notifications

Keep customers informed at every stage with targeted push notifications and in-app alerts.

✓ Order confirmed / ready / delivered alerts
✓ Promotional offer notifications
✓ In-app notification centre
✓ Mark as read / clear all
✓ Per-type notification preferences

💡

Replace each placeholder <div> with <img src="./image/mobile/NAME.png" class="w-full h-full object-cover rounded-2xl" />. Recommended ratio: 9:19.5.

📋

Changelog

v1.0.0 Initial Release

✓ Flutter mobile app (Android + iOS)
✓ Laravel 11 REST API backend
✓ Next.js 14 customer web app
✓ Admin dashboard with full order management
✓ Real-time order tracking
✓ Push notification support

Update changelog on every release to keep buyers informed.