Go4Food Go4Food Docs v1.0.0
Getting Started

Project Structure

What is in the download, which folder builds which app, and the few files you will edit yourself.

The download at a glance#

Go4Food comes as two folders: the main package with the mobile apps, admin panel and backend, and the web package with the customer website and the restaurant web panel.

Go4Food/
├── customer/          Customer app (Android, iOS)
├── restaurant/        Restaurant (owner) app (Android, iOS)
├── driver/            Driver app (Android, iOS)
├── admin_panel/       Admin panel (Flutter web)
├── functions/         Cloud Functions: the secure server logic (Node.js 24)
├── firebase_setup/    Setup tool: rules, indexes, starter data, one-click deploy
├── landing_page/      Marketing website (plain HTML, CSS and JavaScript)
└── documentation/     This documentation (open index.html)

Go4Food-web/
├── customer_web/      Customer website (Flutter web)
└── restaurant_web/    Restaurant web panel (Flutter web)

One Firebase project for everything#

All apps and panels share one Firebase project: the same database, the same sign-in, the same storage. A restaurant approved in the admin panel appears in the customer app at once. An order placed in the customer app reaches the restaurant app straight away.

Do not create a Firebase project per app

Create one project and connect every app and panel to it. Separate projects would not share orders, restaurants or users.

Firestore can hold a second database named staging next to (default), for testing. The apps use (default) unless you switch them: useStaging in lib/constant/constant.dart (mobile apps) or lib/app/constant/constants.dart (admin panel), and useStagingDatabase in lib/constant/constant.dart (customer website and restaurant panel). The functions serve the databases listed in FIRESTORE_DATABASES in functions/.env.

Inside each app folder#

Every Flutter project uses the same layout, so once you know one, you know them all.

customer/
├── lib/
│   ├── main.dart                 Starts Firebase and the app
│   ├── firebase_options.dart     Your Firebase settings (written by FlutterFire)
│   ├── app/
│   │   ├── modules/              One folder per screen (home, my_cart, track_order…)
│   │   ├── models/               Data classes
│   │   ├── routes/               Screen addresses
│   │   └── widget/               Reusable widgets
│   ├── constant/                 App-wide values (including useStaging)
│   ├── services/                 Shared logic
│   ├── payments/                 Payment gateway screens
│   ├── lang/                     Built-in translations (en, ar, fr, hi, pt)
│   ├── themes/                   Colours and text styles
│   └── utils/                    Helpers, Firestore access
├── android/                      Android project (package name, icon, signing, Maps key)
├── ios/                          iPhone project (bundle ID, icon, permissions, Maps key)
├── assets/                       Images, icons and sounds
└── pubspec.yaml                  Packages and app version

The web projects (admin_panel, customer_web, restaurant_web) have a web/ folder instead of android/ and ios/.

The only files you edit yourself#

Almost everything is a setting in the admin panel. These are the exceptions, because a phone or browser needs them when the app is built:

WhatFile(s)Guide
Firebase connectionlib/firebase_options.dart, android/app/google-services.json, ios/Runner/GoogleService-Info.plist (written for you)Connect with FlutterFire
Web push settingsweb/firebase-messaging-sw.js in admin_panel, customer_web and restaurant_webPush keys & setup
Package name / bundle IDandroid/app/build.gradle.kts, Xcode projectPackage names
App name under the iconandroid/app/src/main/AndroidManifest.xml, ios/Runner/Info.plistApp name & icon
Launcher iconandroid/app/src/main/res/mipmap-*, ios/Runner/Assets.xcassetsApp name & icon
Google Maps keyandroid/app/src/main/AndroidManifest.xml, ios/Runner/AppDelegate.swiftGoogle Maps key
Android signingandroid/key.properties + your .jks fileAndroid release
Website names and iconsweb/index.html, web/manifest.json, web/icons/Prepare & build
Staging database (optional)useStaging / useStagingDatabase in each app's constant file, functions/.envFirestore database

Changed from the admin panel, no code

App colours and the in-app name, currency, languages, payment gateways, commission and platform fee, delivery charges, zones, taxes, documents, bank details form, policies, onboarding screens, the landing page, push and email texts. See Admin panel setup.