Version 1.0.0

Hypercommerce Installation & Setup Guide

Everything you need to deploy your multi-vendor ecommerce platform — from server provisioning and the Laravel backend to the mobile apps, Firebase and Google Cloud.

What you'll set up

Hypercommerce ships as four products that share a single backend. Start with the backend, then connect each client app.

Backend, Admin & Seller Panel

The Laravel core that powers your store, admin dashboard and seller portal.

Laravel 13PHP 8.4MySQL

Read guide

Customer App

The Flutter buyer app for Android & iOS, with push, maps and payments.

Flutter 3Firebase

Read guide

Seller AppSoon

Native seller companion app to manage orders, products and payouts on the go.

Flutter 3

Customer WebSoon

Server-rendered storefront for browsers, sharing the same backend API.

Next.js

Recommended order

Follow the guide top to bottom. Each section assumes the previous one is complete.

Suggested path

Server requirements → Backend installation → Firebase & Google Cloud → Payment gateways → Customer App build. The whole flow takes roughly 45–90 minutes on a fresh server.

Before you begin

Make sure you have the following ready. Detailed specs live on the Server Requirements page.

Hosting

VPS or cloud server

Runtime

PHP 8.4+ & Composer

Database

MySQL 8 / MariaDB 10.6

Accounts

Firebase & Google Cloud

Purchase code required

Installation asks for your Envato purchase code. You can find it in your CodeCanyon downloads under License certificate & purchase code.

Getting Started

Server Requirements

Hypercommerce runs on any standard LAMP/LEMP stack. Confirm your server meets the specs below before installing the backend.

Minimum vs. recommended

The minimum specs run a development or small store. For production traffic we recommend the values in the Recommended column.

Minimum requirements

Component	Minimum	Recommended	Required
PHP	`8.4`	`8.4+`	Yes
MySQL / MariaDB	`MySQL 8.0 / MariaDB 10.6`	`MySQL 8.0`	Yes
Composer	`2.2`	`2.7+`	Yes
Web server	`Apache 2.4 / Nginx 1.20`	`Nginx 1.24`	Yes
RAM	`1 GB`	`2 GB+`	Yes

PHP extensions

The following PHP extensions must be enabled. Most are bundled with standard PHP installs.

GD or Imagick

Image resizing for product galleries needs either GD or Imagick. Imagick produces sharper thumbnails and is preferred when available.

Recommended hosting

Hypercommerce works on shared hosting, but a VPS or cloud server is strongly recommended for queues, cron and media storage.

The recommended setup. Full control over PHP, Nginx, Redis and cron — required for background jobs and push notifications.

Ubuntu 22.04 LTS or 24.04 LTS, 2 vCPU, 2–4 GB RAM, 40 GB SSD
Nginx + PHP-FPM 8.4 + MySQL 8.0
Redis for queue driver (phpredis extension)
Supervisor to keep queue workers alive

Verify your environment

SSH into your server and confirm the installed versions before continuing to installation.

check-environment.shTerminal

# Confirm PHP version (must be 8.4+)php -v # List enabled PHP extensionsphp -m # Confirm Composer is installedcomposer --version # Confirm database connectivitymysql --version

All set?

If every version matches the table above, continue to Backend Installation.

Backend · Admin · Seller Panel

Backend Installation

Install the Laravel core that powers your admin dashboard, seller panel and the API behind every Hypercommerce app.

Estimated time

10–15 min

Difficulty

Intermediate

You'll need

Purchase code

Guided web installer

Hypercommerce installs through a built-in web installer — there's no manual .env editing or Artisan commands. Just upload, point it at a database, and finish setup in your browser.

Using shared hosting? Follow a hosting-specific walkthrough:

Overview

At a high level, you upload the files and point your domain at the /public folder — then the built-in web installer handles everything else in the browser: licensing, requirement and permission checks, your database connection, and creating your admin account, running all migrations and seeders for you. Here's the full path:

Upload & extract the package, then point the domain at /public
Create an empty MySQL database and user (you'll enter these in the installer)
Open /install and complete the guided wizard
After install, schedule cron & the queue worker

Step-by-step installation

1

Upload & extract files

Upload hypercommerce.zip to your server's web root (e.g. /var/www/hypercommerce) and extract it. Point your domain or subdomain at the /public directory.

Terminal

cd /var/wwwunzip hypercommerce.zip -d hypercommerce

Dependencies are bundled

The CodeCanyon package ships with its vendor folder, so you don't need to run Composer. Only if you're installing from a fresh-source package should you run composer install --no-dev --optimize-autoloader.

Document root

Your domain must serve the /public folder — never the project root. On Apache the bundled .htaccess handles this; on Nginx set root /var/www/hypercommerce/public;.

2

Create the database

Create an empty MySQL database and a user with full privileges on it. Keep these credentials handy for the next step.

MySQL

CREATE DATABASE hypercommerce CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;CREATE USER 'hc_user'@'localhost' IDENTIFIED BY 'a-strong-password';GRANT ALL PRIVILEGES ON hypercommerce.* TO 'hc_user'@'localhost';FLUSH PRIVILEGES;

3

Run the installer

Install entirely from your browser — no terminal or manual configuration required. Open https://your-domain.com/install and the wizard guides you through each step in order:

Welcome — confirm you're ready to begin.
License — enter your Envato purchase code. It's verified online and your domain is registered automatically.
Requirements — the installer checks your PHP version and required extensions.
Permissions — it confirms storage and bootstrap/cache are writable.
Environment & Database — enter your database hostname, username, password and database name. The installer tests the connection and writes your .env for you.
Admin account — set your super-admin name, email, password and mobile.
Install — migrations and seeders run automatically, then you're taken to the finished screen.

Installer welcome screen — **Fig 1.** Welcome — start the guided setup.

License — purchase code and domain — **Fig 2.** License — enter your purchase code; the domain is bound to your license.

Requirements check — **Fig 3.** Requirements — PHP version, extensions and functions are verified.

Folder permissions check — **Fig 4.** Permissions — `storage` and `bootstrap/cache` must be writable (775).

Environment and database details — **Fig 5.** Environment & Database — enter your hostname, username, password and database.

Super admin account details — **Fig 6.** Admin account — set your super-admin name, email, password and mobile.

Installation finished — **Fig 7.** Finished — migrations and seeders have run and your admin account is ready.

Activate your license

Enter the Envato purchase code when prompted. Activation unlocks automatic updates from inside the admin panel.

Resetting your purchase code

To move your license to a new domain or reset an already-activated purchase code, contact our support team and we'll release it for you.

4

Set file permissions

The installer's Permissions step checks this for you. If it flags storage or bootstrap/cache as not writable, set ownership to your web-server user (often www-data) and re-check.

Terminal

# Give the web server ownershipsudo chown -R www-data:www-data storage bootstrap/cache # Apply write permissionssudo chmod -R 775 storage bootstrap/cache

5

Schedule cron & queue

Hypercommerce uses Laravel's task scheduler and a queue worker to process orders, payouts, notifications and currency-rate refreshes. The admin panel generates the exact commands for you — how you run them depends on your hosting.

Get the commands from the admin panel

After installing, log in and open Cron Monitor. It shows two ready-to-copy commands — Task Scheduler (schedule:run) and Queue Worker (queue:work) — each with a copy button and a live health indicator. It fills in your server's real PHP binary and project path for you.

Shared hosting (cPanel, hPanel, etc.) — copy both commands from Cron Monitor and add each as a cron job set to run every minute. The leading * * * * * is what makes a job run once a minute, every minute:

Cron jobscrontab

# Task scheduler — runs every minute* * * * * /usr/bin/php /home/youruser/your-site/artisan schedule:run >> /home/youruser/your-site/storage/logs/schedule.txt 2>&1 # Queue worker — runs every minute* * * * * /usr/bin/php /home/youruser/your-site/artisan queue:work --stop-when-empty >> /home/youruser/your-site/storage/logs/cron-log.txt 2>&1

Use the paths shown in Cron Monitor

Don't hand-type the paths above — they're placeholders. Copy each command straight from Cron Monitor so the PHP binary and project path match your server exactly. Once a task has run, its indicator on that page turns green.

VPS or dedicated server — if you have shell access and can run long-lived processes, you don't need a per-minute cron at all. Run the scheduler and queue worker as persistent background processes instead, kept alive by Supervisor so they restart on crash or reboot:

Terminal

# Run the scheduler continuously — replaces the every-minute cronphp artisan schedule:work # Process queued jobs continuouslyphp artisan queue:work --tries=3 --timeout=90

Define a Supervisor program for each so they stay running in the background:

/etc/supervisor/conf.d/hypercommerce.confini

[program:hypercommerce-scheduler]command=php /var/www/hypercommerce/artisan schedule:workautostart=trueautorestart=trueuser=www-data [program:hypercommerce-queue]command=php /var/www/hypercommerce/artisan queue:work --tries=3 --timeout=90autostart=trueautorestart=truenumprocs=1user=www-data

Apply the Supervisor config

After saving the file, run sudo supervisorctl reread && sudo supervisorctl update && sudo supervisorctl start all. Cron Monitor still shows live health for both tasks regardless of how they run.

Post-install checklist

Once the installer finishes, confirm each item below before going live.

Admin login works. Sign in at /admin with the credentials you set during install.

License activated. The dashboard shows a green “Licensed” badge under Settings → License.

Cron is running. Settings → System Health reports the scheduler ran within the last minute.

Storage is writable. Test by uploading a product image in the admin panel.

Troubleshooting

The most common installation issues and their fixes.

500 error after install

Almost always a permissions issue. Re-run the chmod from Step 4 and clear caches with php artisan optimize:clear.

Installer can't connect to database

Double-check the DB_* values in .env. On many hosts DB_HOST should be 127.0.0.1 rather than localhost.

Still stuck?

Open a ticket with your server's System Health report attached — it captures PHP version, extensions and folder permissions in one click.

Backend · Admin · Seller Panel

Hostinger Admin Panel Setup

Deploy Hypercommerce on Hostinger shared hosting using hPanel, File Manager, and the built-in web installer.

Estimated time

15–20 min

Difficulty

Beginner

You'll need

Hostinger account & purchase code

1

Create Website and Database

Log in to your Hostinger account.
Create a new website for the admin panel.
Navigate to Hosting → Manage → Databases → MySQL Databases and create a new database and user.
Note down the following credentials — they are required during the installation wizard:

Database Name

Keep a record

Database Username

Keep a record

Database Password

Keep a record

Database Host

Usually localhost

2

Upload and Extract Admin Panel Files

Open Hostinger File Manager from hPanel.
Navigate to the website's root directory — usually public_html.
Upload the Admin Fresh Code ZIP file provided in the CodeCanyon package.
Extract the ZIP file directly inside the root directory.

If ZIP Extraction Fails

Some large ZIP files may not extract properly through File Manager. In that case, use SSH:

In hPanel, go to Advanced → SSH Access and enable SSH access.
Set an SSH password and copy the SSH connection command provided by Hostinger.
Open Terminal (macOS / Linux) or Command Prompt / PuTTY (Windows) and connect using the copied command.
Navigate to the directory containing the uploaded ZIP:

TerminalBash

cd /path/to/your/website

Then extract the archive — replace admin-panel.zip with the actual filename:

TerminalBash

unzip admin-panel.zip

3

Run the Web Installer

Open your website URL in a browser.
The installation wizard will start automatically.
Enter the database credentials created in Step 1.
Complete the installation process by following the on-screen instructions.
After installation is complete, log in to the admin panel using the credentials you configured.

The web installer

The wizard is identical on every host — see the full screen-by-screen walkthrough on the Backend Installation page.

Installation Complete

Your admin panel is now successfully installed and ready for use.

Next steps

Continue with Firebase Setup to connect push notifications and authentication to your admin panel.

Backend · Admin · Seller Panel

cPanel Setup

Deploy Hypercommerce on a cPanel server using the MySQL Database Wizard, File Manager, and the built-in web installer.

Estimated time

15–20 min

Difficulty

Beginner

You'll need

cPanel account & purchase code

1

Create a MySQL database & user

Log in to your cPanel account.
Under Databases, open the MySQL® Database Wizard.
Create a new database, then create a database user with a strong password.
Add the user to the database and grant it ALL PRIVILEGES.
Note these credentials — you'll enter them in the installer:

Database Name

Often cpuser_dbname

Database Username

Often cpuser_dbuser

Database Password

Keep a record

Database Host

Usually localhost

2

Upload and extract the files

Open File Manager from cPanel.
Navigate to your domain's root — public_html for the primary domain, or the addon/subdomain folder.
Upload the Admin code ZIP from your CodeCanyon package.
Select the archive and choose Extract.

If extraction fails

Large archives may not extract through File Manager. If your plan includes Terminal or SSH access, extract from the command line instead:

TerminalBash

cd ~/public_htmlunzip admin-panel.zip

3

Point the domain at `/public`

Hypercommerce must be served from its /public folder — never the project root.

Recommended: in Domains, set the domain or subdomain's Document Root to the extracted …/public directory.
If your plan can't change the document root, extract into public_html and move the contents of public_html/public up into public_html. The bundled .htaccess handles routing on Apache.

Serve /public only

If the domain points at the project root instead of /public, your .env and source files become publicly accessible and the app won't load correctly.

4

Run the web installer

Open your website URL in a browser — you'll be taken to /install.
Complete the wizard: license, requirements, permissions, the database credentials from Step 1, and your admin account.
When it finishes, log in to your admin panel with the credentials you set.

The web installer

The wizard is identical on every host — see the full screen-by-screen walkthrough on the Backend Installation page.

Installation Complete

Your admin panel is installed and ready. Set up the scheduler and queue worker using cPanel's Cron Jobs — the exact commands are shown on the Backend Installation page (Step 5).

Next steps

Continue with Firebase Setup to connect push notifications and authentication.

Backend · Admin · Seller Panel

Firebase Setup

Hypercommerce manages Firebase entirely from the Admin Panel. Configure authentication and push notifications once, and they apply to the Customer Web and apps automatically — no .env editing required.

Before you start

Your Admin Panel must already be installed and reachable (for example on a subdomain). You'll also need access to the Firebase Console with permission to create a project.

Connect your Firebase project

Create a Firebase project, register a Web App, then paste its configuration into the Admin Panel.

1

Create a Firebase project

Go to the Firebase Console and create a new project — or select an existing one to reuse.

Firebase Console — create a new project — **Fig.** Creating a new Firebase project from the console.

2

Add a Web App

Inside the project, add a new Web App using the </> icon and give it a nickname.

Register the Web App — **Fig.** Give the app a nickname and click **Register app**.

3

Copy your Firebase config

Open Project settings from the gear menu next to Project Overview.

Under your Web App, copy the SDK configuration values — apiKey, authDomain, databaseURL, projectId, storageBucket, messagingSenderId, appId and measurementId.

Firebase SDK config values — **Fig.** The SDK configuration values shown under Project settings.

4

Save it in the Admin Panel

In your Admin Panel, go to Settings → Authentication → Firebase, turn on Enable Firebase, paste each value into its matching field (API Key, Auth Domain, Database URL, Project ID, Storage Bucket, Messaging Sender ID, App ID and Measurement ID), then click Save.

Admin Panel — Settings → Authentication → Firebase — **Fig.** Pasting the Firebase config into the Admin Panel.

Enable push notifications

Generate the Web Push key and a service account key in Firebase, then add both to the Admin Panel.

1

Generate a Web Push (VAPID) key

In the Firebase Console go to Project Settings → Cloud Messaging. Under Web Push certificates, click Generate key pair and copy the generated VAPID key.

Cloud Messaging — Web Push certificates — **Fig.** Generating a Web Push certificate (VAPID) key pair under Cloud Messaging.

2

Download the service account key

Go to Project Settings → Service Accounts, click Generate New Private Key, and save the downloaded JSON file securely.

Service Accounts — generate new private key — **Fig.** Generating the service account private key (JSON).

Keep this file private

The service account JSON grants server-side access to your Firebase project. Never commit it to source control or share it publicly.

3

Configure notifications in the Admin Panel

In your Admin Panel, go to Settings → Notifications. Enter the VAPID key, upload the service account JSON file, and Save.

Admin Panel — Settings → Notifications — **Fig.** Adding the Project ID, service account file and VAPID key in the Admin Panel.

Stored securely, applied automatically

The Admin Panel stores these values and applies them to the Customer Web and apps automatically. No manual .env editing is required.

Final checklist

Admin Panel reachable. The panel is hosted and accessible on your domain or subdomain.

Firebase config added. The SDK values are saved under Settings → Authentication → Firebase.

Push keys added. The VAPID key and service account JSON are saved under Settings → Notifications.

Google Maps key added. Configure this on the Google Cloud & Maps page.

Backend · Admin · Seller Panel

Google Cloud & Maps

Set up the Google Cloud services that power Maps in the Admin Panel and storefront — a billing account, the required Maps APIs, an API key, and adding that key to the Admin Panel.

APIs you must enable

For Maps to work across the Admin Panel and Website, enable these in your Google Cloud project: Places API (New), Geocoding API (address conversion) and Maps JavaScript API (displaying maps).

Step-by-step setup

1

Enable a billing account

Google Maps Platform APIs require a valid billing account on your Google Cloud project. Create one and make sure billing is active before continuing.

Create a billing account — **Fig.** Creating a billing account in the Google Cloud Console.

2

Enable the required APIs

Go to APIs & Services → Library, then search for and enable each one: Places API (New), Geocoding API and Maps JavaScript API.

**Fig.** Enabling the Maps APIs from the API Library.

3

Create & configure an API key

Go to APIs & Services → Credentials, then click Create credentials → API key.

**Fig.** The Credentials page where you create the API key.

Open the new key to configure it. Check whether it is restricted to specific domains, and that the Maps APIs above are allowed under API restrictions.

API key restrictions — **Fig.** Configuring application and API restrictions on the key.

4

Add the API key to the Admin Panel

Log in to your Admin Panel and go to Settings → Web Settings. Under Support Information, paste your key into the Google Map Key field and click Submit.

Admin Panel — Web Settings — Google Map Key — **Fig.** Adding the Google Map Key under Web Settings → Support Information.

5

Verify

Check that Google Maps loads correctly in the Admin Panel or Customer Website. If the map doesn't load, confirm the following:

APIs enabled. Maps JavaScript API, Places API (New) and Geocoding API are all enabled.

No blocking restrictions. Domain or API restrictions on the key aren't blocking your current domain.

Still not loading?

Revisit the Credentials page in the Google Cloud Console and confirm no restriction is blocking requests from your domain.

Customer App

Prerequisites

The Customer App is a feature-rich mobile application built with Flutter, giving your users a seamless shopping experience on iOS and Android.

Overview

The Customer App is the primary interface for users to interact with your platform on mobile. It's built with Flutter to deliver:

Native performance on both iOS and Android
A consistent experience across platforms
Smooth animations and transitions
Offline capability for basic features
Real-time order tracking and updates

System requirements

For users

Android 6.0 (API level 23) or higher

iOS 12 or higher

100 MB free storage space

Internet connection

For developers

Tool	Minimum
Flutter	`3.0+`
Dart SDK	`2.17+`
IDE	Android Studio or VS Code

Developer & signing accounts

You can build and run the app locally for testing without any paid accounts. To publish to the public stores you'll need the platform developer accounts below — set these up before you reach the Build & Release step.

Google Play Console

Publish the Android app (one-time fee)

Apple Developer Program

Publish the iOS app (annual membership)

iOS builds need macOS

Building and signing an iOS release requires a Mac with Xcode installed. Android can be built from Windows, macOS or Linux.

Next step

Once your environment is ready, continue to App Configuration to point the app at your backend.

Customer App

App Configuration

Point the Customer App at your backend and set its identity. Almost everything lives in one file — lib/config/constant.dart — plus a few native values for the app name, package ID and Maps keys.

Payments need no app change

Gateway keys (Stripe, Razorpay, Paystack, Flutterwave) are fetched at runtime from your backend's /api/settings and configured in the Admin Panel — there's nothing to set in the app for payments.

Core settings — `constant.dart`

Open lib/config/constant.dart and replace each placeholder with your own value.

lib/config/constant.dartDart

class AppConstant {  // Your backend API base URL — must end with a trailing slash  static String baseUrl       = 'https://your-domain.com/api/';  static String appName       = 'Your App Name';  static String packageName   = 'com.yourcompany.app';  // Google Maps keys (used for Places & Geocoding REST calls)  static String androidMapKey = 'YOUR_ANDROID_MAP_KEY';  static String iosMapKey     = 'YOUR_IOS_MAP_KEY';  // Google Sign-In server client ID (OAuth web client)  static String serverClientId= 'YOUR_SERVER_CLIENT_ID';}

baseUrl

Your installed backend, ending in /api/

appName

Display name used inside the app

packageName

Must match your Android/iOS bundle ID

androidMapKey / iosMapKey

From Google Cloud & Maps

serverClientId

Google OAuth web client ID for sign-in

Keep the trailing slash on baseUrl

All endpoints are built as '${baseUrl}login', '${baseUrl}categories' and so on (see lib/config/api_routes.dart). A missing trailing slash breaks every request.

Android identity

Update these native Android values to match your packageName and branding.

android/app/build.gradle

applicationId & namespace (default com.hyperCommerce.customer)

AndroidManifest.xml

android:label → your app name

AndroidManifest.xml

com.google.android.geo.API_KEY → your Android Maps key

android/app/src/main/AndroidManifest.xmlXML

<application android:label="Your App Name" …>   <!-- Google Maps API Key -->  <meta-data    android:name="com.google.android.geo.API_KEY"    android:value="YOUR_ANDROID_MAP_KEY" />

iOS identity

In Xcode (ios/Runner.xcworkspace) and the iOS files:

Bundle Identifier

Set PRODUCT_BUNDLE_IDENTIFIER in Xcode → Signing & Capabilities

ios/Runner/Info.plist

CFBundleDisplayName & CFBundleName → your app name

ios/Runner/AppDelegate.swift

GMSServices.provideAPIKey(...) → your iOS Maps key

ios/Runner/AppDelegate.swiftSwift

GMSServices.provideAPIKey("YOUR_IOS_MAP_KEY")

Available customizations

Everything you can rebrand, and where each value lives in the project.

Customization	Where	What to change
App color	`lib/config/theme.dart`	`primaryColor` hex
Package / Bundle ID	`build.gradle` · Xcode	`applicationId` / bundle identifier
App logo & icon	`assets/images/app_launcher_logo/` · `app_logos/`	Replace PNGs, regenerate icons
App name	`constant.dart` · Manifest · Info.plist	`appName` / label
Base URL	`lib/config/constant.dart`	`baseUrl`
Firebase (CLI)	`flutterfire configure`	See Firebase & Push
Server client ID	`lib/config/constant.dart`	`serverClientId`
Android Maps key	`constant.dart` · Manifest	`androidMapKey` / geo API_KEY
iOS Maps key	`constant.dart` · AppDelegate.swift	`iosMapKey`

App color

The primary brand color is defined once in lib/config/theme.dart. Change the hex and it flows through buttons, the active nav bar, badges and accents.

lib/config/theme.dartDart

class AppTheme {  // Your brand color — default is amber 0xFFFFB616  static const Color primaryColor = Color(0xFFFFB616);  …}

App logo & launcher icon

Two sets of images: the in-app logo and the home-screen launcher icon.

In-app logo — replace assets/images/app_logos/app-logo-light.png and app-logo-dark.png.
Launcher icon — replace assets/images/app_launcher_logo/launcher_icon.png (used by flutter_launcher_icons for both Android and iOS, already configured in pubspec.yaml).

Then regenerate the platform icons:

TerminalBash

flutter pub getdart run flutter_launcher_icons

Use a square source image

Provide launcher_icon.png at a high resolution (1024×1024). The generator handles the adaptive-icon foreground/background and every density automatically.

Regenerate & run

After editing the values above, fetch packages and run the code generator, then launch the app.

TerminalBash

# Install dependenciesflutter pub get # Run the code generator (Hive / models)flutter pub run build_runner build --delete-conflicting-outputs # Launch on a connected device or emulatorflutter run

Next step

Connect push notifications and authentication by adding your Firebase files on the Firebase & Push page.

Customer App

Firebase & Push

To use authentication and push notifications in the Customer App you must set up Firebase for both Android and iOS. You can do this automatically with the FlutterFire CLI (recommended) or manually.

Server-side keys live in the Admin Panel

The FCM service account JSON and Google Maps keys are entered in the Admin Panel — see Firebase Setup. This page covers the Firebase files the app itself needs.

Method 1 — FlutterFire CLI Recommended

The fastest, most reliable way — it generates the correct configuration files for every platform automatically.

1

Install the Firebase CLI

TerminalBash

# Install globally using npmnpm install -g firebase-tools

2

Log in to Firebase

TerminalBash

firebase login

On a headless server?

Use firebase login --no-localhost if the machine has no browser.

3

Install the FlutterFire CLI

TerminalBash

# Activate the CLI globallyflutter pub global activate flutterfire_cli

Add Flutter's bin to PATH

So flutterfire runs from anywhere — on macOS/Linux that's usually ~/.pub-cache/bin.

4

Configure the project

Run this from the root of the Flutter project — it's interactive:

TerminalBash

flutterfire configure

Answer the interactive prompts:

Project selection — pick your Firebase project from the list.
Platform selection — toggle android and ios with the Spacebar.
Reuse existing firebase.json? — answer no.
Overwrite lib/firebase_options.dart? — answer Yes so it's updated with your project credentials.

Example output

✔ Firebase configuration file lib/firebase_options.dart generated successfully Platform   Firebase App Idandroid    1:123456789012:android:xxxxxxxxxxxxxxxxios        1:123456789012:ios:xxxxxxxxxxxxxxxx

Method 2 — Manual setup

Prefer to place each native file yourself? Follow these steps instead.

1

Create the Firebase project

Go to the Firebase Console and create or select your project.

Create Firebase project — **Fig.** Creating or selecting a Firebase project.

2

Add the Android app

Click Add app → Android, enter the Android package name (from android/app/src/main/AndroidManifest.xml), then download google-services.json and place it in android/app/.

Register Android app — **Fig.** Registering the Android app with your package name.

google-services.json placed in android/app — **Fig.** `google-services.json` placed in `android/app/`.

3

Release keystore & SHA fingerprints

Google Sign-In and phone auth need your app's SHA fingerprints. Generate a release keystore (if you don't have one):

TerminalBash

# Check if a keystore already existsls android/app/*.jks android/*.jks 2>/dev/null # Generate a new release keystore (example)keytool -genkeypair -v -keystore android/app/release-key.jks \  -alias upload -keyalg RSA -keysize 2048 -validity 10000

Then print the fingerprints and add them in Firebase:

TerminalBash

cd android./gradlew signingReport

Copy the release (and debug, if you sign in on debug builds) SHA-1 and SHA-256 into Project settings → General → your Android app → Add fingerprint.

Add SHA fingerprints — **Fig.** Adding SHA-1 / SHA-256 fingerprints to the Android app.

4

Add the iOS app

Click Add app → iOS, enter the iOS bundle ID (Xcode → Runner → General), download GoogleService-Info.plist and add it to ios/Runner/ in Xcode.

Register iOS app — **Fig.** Registering the iOS app with your bundle ID.

GoogleService-Info.plist placed in ios/Runner — **Fig.** `GoogleService-Info.plist` placed in `ios/Runner/`.

iOS auth config: open ios/Runner/GoogleService-Info.plist, copy REVERSED_CLIENT_ID, then in Xcode update ios/Runner/Info.plist → CFBundleURLSchemes to match it.

Info.plist URL schemes with REVERSED_CLIENT_ID — **Fig.** Setting `CFBundleURLSchemes` to your `REVERSED_CLIENT_ID`.

Common steps (both methods)

Initialize Firebase in code

Ensure lib/main.dart initializes Firebase before the app runs:

lib/main.dartDart

import 'package:firebase_core/firebase_core.dart';import 'firebase_options.dart'; void main() async {  WidgetsFlutterBinding.ensureInitialized();  await Firebase.initializeApp(    options: DefaultFirebaseOptions.currentPlatform,  );  runApp(const MyApp());}

Enable authentication providers

In Firebase Console → Authentication → Sign-in method, enable Phone, Google, Email/Password and Apple.

Select sign-in providers — **Fig.** Selecting the sign-in providers to enable.

Enabled sign-in providers — **Fig.** All four providers enabled.

Server client ID (Google Sign-In)

The serverClientId you set in lib/config/constant.dart is the Web OAuth client ID — found as the client_id with client_type: 3 in your google-services.json (or under Google Cloud → Credentials → OAuth 2.0 Web client).

OAuth client_id in google-services.json — **Fig.** The `client_id` (Web client) used for `serverClientId`.

Final checklist

Admin Panel reachable. Hosted and accessible on your domain or subdomain.

Firebase configured. Via CLI or manually, with config files placed correctly (firebase_options.dart, google-services.json, GoogleService-Info.plist).

FCM credentials in Admin. Service account JSON added under Admin Panel → Settings → Notifications.

Google Maps keys in Admin. Added in the Admin Panel (see Google Cloud & Maps).

Customer App

Build & Release

Produce signed release builds and ship the Customer App to Google Play and the App Store. Make sure you've finished App Configuration and Firebase & Push first.

Set the version

Bump the version in pubspec.yaml before each release. The format is versionName+versionBuild — the build number after + must increase for every store upload.

pubspec.yamlYAML

# versionName + versionBuild (build number)version: 1.0.0+1

Android release

1

Configure release signing

Using the release keystore you generated in Firebase & Push, create android/key.properties. The project's build.gradle already reads it for the release signing config.

android/key.propertiesProperties

storePassword=yourStorePasswordkeyPassword=yourKeyPasswordkeyAlias=upload# path to your .jks, relative to android/app/storeFile=release-key.jks

Never lose your keystore

Keep the .jks file and its passwords safe and out of source control. If you lose them you can't publish updates under the same app.

2

Build a signed App Bundle

Google Play requires an Android App Bundle (.aab):

TerminalBash

flutter build appbundle --release # output: build/app/outputs/bundle/release/app-release.aab # for a direct-install APK instead:flutter build apk --release

3

Upload to Google Play

In the Google Play Console, create your app, upload the .aab to an Internal testing track first, then promote it to Production once verified.

iOS release

macOS + Xcode required

iOS release builds can only be produced on a Mac with Xcode and a paid Apple Developer account.

1

Set up signing in Xcode

Open ios/Runner.xcworkspace in Xcode. Under Runner → Signing & Capabilities, select your Team and confirm the Bundle Identifier matches your registered App ID.

2

Build & archive

TerminalBash

flutter build ipa --release # or in Xcode: Product → Archive

3

Upload to App Store Connect

Upload the build with the Xcode Organizer (Distribute App) or Transporter, then submit it for review from App Store Connect.

Store listings

Before either store will publish, prepare your listing assets and complete the required forms.

App icon & screenshots for each required device size.

Title, description & category for the listing.

Privacy policy & data-safety forms (required by both stores).

Review notes & test account so reviewers can sign in and test.

Hypercommerce Installation & Setup Guide

What you'll set up

Backend, Admin & Seller Panel

Customer App

Seller AppSoon

Customer WebSoon

Recommended order

Before you begin

Server Requirements

Minimum requirements

PHP extensions

Recommended hosting

Verify your environment

Backend Installation

Overview

Step-by-step installation

Upload & extract files

Create the database

Run the installer

Set file permissions

Schedule cron & queue

Post-install checklist

Troubleshooting

Hostinger Admin Panel Setup

Create Website and Database

Upload and Extract Admin Panel Files

If ZIP Extraction Fails

Run the Web Installer

Installation Complete

cPanel Setup

Create a MySQL database & user

Upload and extract the files

If extraction fails

Point the domain at /public

Run the web installer

Installation Complete

Firebase Setup

Connect your Firebase project

Create a Firebase project

Add a Web App

Copy your Firebase config

Save it in the Admin Panel

Enable push notifications

Generate a Web Push (VAPID) key

Download the service account key

Configure notifications in the Admin Panel

Final checklist

Google Cloud & Maps

Step-by-step setup

Enable a billing account

Enable the required APIs

Create & configure an API key

Add the API key to the Admin Panel

Verify

Prerequisites

Overview

System requirements

For users

For developers

Developer & signing accounts

App Configuration

Core settings — constant.dart

Android identity

iOS identity

Available customizations

App color

App logo & launcher icon

Regenerate & run

Firebase & Push

Method 1 — FlutterFire CLI Recommended

Install the Firebase CLI

Log in to Firebase

Install the FlutterFire CLI

Configure the project

Method 2 — Manual setup

Create the Firebase project

Add the Android app

Release keystore & SHA fingerprints

Add the iOS app

Common steps (both methods)

Point the domain at `/public`

Core settings — `constant.dart`