Gromart Documentation

2. Setup Setting up Flutter involves several steps. Here’s a basic guide to get you started:

2.1. System Requirements:

Ensure your system meets the minimum requirements for Flutter development. Flutter supports development on Windows, macOS, and Linux. Make sure your system has the necessary hardware and software requirements as specified by Flutter documentation.

2.2. Install Flutter SDK:

Download the Flutter SDK from the official Flutter website.

Download the Flutter SDK Version of 3.22.3.

Extract the downloaded file to a location on your system. For example, on macOS or Linux, you can extract it to /usr/local and on Windows to C:\.

Add the Flutter bin directory to your system PATH to run Flutter commands from the command line. This step is important for executing Flutter commands globally in your system.

2.3. Install Development Tools:

For Android: Install Android Studio and configure the Flutter plugin. Android Studio provides the Android SDK, which Flutter uses to develop for Android. Ensure you have the Android SDK and the necessary tools installed through Android Studio.

For iOS: You need a macOS system with Xcode installed to develop and deploy Flutter apps for iOS.

2.4. Set up Android Emulator or iOS Simulator:

For Android development, set up an Android Virtual Device (AVD) using Android Studio’s AVD Manager.

For iOS development, use the iOS Simulator provided by Xcode.

Run flutter doctor:

Open a terminal and run flutter doctor. This command checks your system for any dependencies needed for Flutter development.

It will provide feedback on any missing or outdated components and instructions on how to resolve them.

2.5. Install Flutter and Dart plugins for your preferred IDE:

If you’re using VS Code, install the Flutter and Dart plugins to enhance your development experience.

Android Studio also has built-in support for Flutter, but make sure to install the Flutter plugin if it’s not already installed.

2.6. Create your first Flutter project:

Use the flutter create command to create a new Flutter project.

Navigate to the project directory and explore the file structure. You’ll find the main Dart file (main.dart) in the lib directory, where you’ll write your Flutter code.

2.7. Run your Flutter app:

Connect a device or start an emulator/simulator.

Navigate to your Flutter project directory in the terminal and run flutter run.

This will compile your Flutter app and launch it on the connected device or
emulator.

2.8. Start Developing:

Once your app is running, you can start developing your Flutter UI and logic. Flutter’s hot reload feature allows you to see your changes instantly without restarting the app.

2.9. Learn and Explore:

Flutter has an extensive set of widgets and libraries. Explore the official Flutter documentation and community resources to learn more about Flutter development.

3. Changing the package name (also known as the bundle identifier or application ID) in a Flutter project involves a few steps. Here’s how you can do it:

3.1. Change the Android package name:

Navigate to the android directory within your Flutter project.

Open the AndroidManifest.xml file located in the app/src/main directory.

Find the package attribute in the tag and change its value to your desired package name.

3.2. Change the iOS bundle identifier:

Navigate to the ios directory within your Flutter project.

Open the Runner.xcodeproj project file using Xcode.

In Xcode, select the Runner project from the project navigator.

Go to the Runner target’s settings.

Under the General tab, find the Bundle Identifier field and change it to your desired bundle identifier.

3.3. Update Flutter project configuration:

Open the pubspec.yaml file located in the root directory of your Flutter project.

Update the name field with your new package name.

Update the android: package field under flutter: with your new package name.

3.4. Update Android source code references:

Open the MainActivity.java file located in android/app/src/main/java/com/your_old_package_name.

Replace occurrences of the old package name with the new package name.

3.5. Update iOS source code references:

Open the AppDelegate.swift file located in ios/Runner.

Replace occurrences of the old bundle identifier with the new bundle identifier.

3.6. Clean and rebuild the project:

After making the necessary changes, clean and rebuild the project.

In Android Studio, you can clean the project by selecting Build > Clean
Project.

In Xcode, you can clean the project by selecting Product > Clean Build
Folder.

3.7. Test your changes:

Run your Flutter app on both Android and iOS devices/emulators to ensure that the changes have been applied successfully.

Verify that the app runs without any issues and that the new package name/bundle identifier is reflected correctly.

4. To change the launcher icon (app icon) in a Flutter project, you
can follow these steps:

4.1. Prepare Your New Icons:

First, prepare the new launcher icon images in the required sizes. Android and iOS have different size requirements. You typically need icons in various sizes to support different screen densities.

Android:

For Android, you need to replace the existing launcher icon files with your new ones. The launcher icons for Android are stored in the mipmap folders inside the android/app/src/main/res directory.

Replace the existing icon files (ic_launcher.png) in the mipmap folders with your new icon files. Make sure to maintain the same file names and sizes.

You may need to replace icons in various drawable folders for different screen densities (e.g., mipmap-hdpi, mipmap-mdpi, mipmap-xhdpi, mipmap-xxhdpi, mipmap-xxxhdpi).

iOS:

For iOS, you need to replace the existing icon files with your new ones. The icons for iOS are stored in the Assets.xcassets directory in the ios/Runner directory.

Open your Flutter project in Xcode by navigating to the ios directory and opening the .xcworkspace file with Xcode.

In Xcode, navigate to Runner > Assets.xcassets.

Replace the existing AppIcon with your new icon files. You’ll typically find different sizes labelled for various devices (e.g., iPhone, iPad).

4.2. Flutter Launcher Icon Package (Optional):

Alternatively, you can use the flutter_launcher_icons package to automate the process of updating launcher icons. This package allows you to define a single source image and generate the required icons for both Android and iOS.

Install the flutter_launcher_icons package by adding it to your pubspec.yaml file:

dev_dependencies:
flutter_launcher_icons:"^0.9.2"

Run the following command in your terminal to generate launcher icons
based on your configuration:

flutter pub get
flutter pub run flutter_launcher_icons:main

Follow the prompts to configure the package according to your project’s
requirements.

4.3. Test Your Changes:

After replacing the icon files or running the flutter_launcher_icons package, rebuild your Flutter project and run it on both Android and iOS devices/emulators to ensure that the new launcher icon is displayed correctly.

5. To change the app name in a Flutter project for Android, iOS, and web platforms, you’ll need to adjust settings in each platform’s configuration. Here’s how you can do it:

5.1. For Android:

• 5.1.1. Open the android/app/src/main/AndroidManifest.xml file.
• 5.1.2. Locate the <application> tag.
• 5.1.3. Change the value of the android:label attribute to your desired app name.

5.2. For iOS:

• 5.2.1. Open the ios/Runner/Info.plist file.
• 5.2.2. Locate the <key>CFBundleDisplayName</key> entry.
• 5.2.3. Change the value associated with <string> to your desired app name.

5.3. For Web:

• 5.3.1. Open the web/index.html file.
• 5.3.2. Locate the <key>title</key> tag.
• 5.3.3. Change the text within the <title> tag to your desired app name.

5.4. Additionally:

In your Flutter project directory, open the pubspec.yaml file and ensure that the name field is set to the desired app name. This is the name that appears in the app store listings, on the device’s home screen, etc.

After making these changes, rebuild your app for each platform to apply the new app name.

5.5. Example:

Let’s say you want to change the app name to “My New App”:

5.5.1. Android:

<application
android:label="My New App" ...>

5.5.2. iOS:

<key>CFBundleDisplayName</key>
<string>My New App</string>

5.5.3. Web:

<title>My New App</title>

5.5.4. Pubspec.yaml:

name: my_new_app

6. To change the Google Maps API key in a Flutter app for both Android and iOS, you need to update the respective configuration files in each platform. Here are the steps:

6.1. For Android:

• 6.1.1. Navigate to your Flutter project’s android/app/src/main/AndroidManifest.xml file.
• 6.1.2. Inside the element, locate the tag with the name com.google.android.geo.API_KEY.
• 6.1.3. Replace the android:value attribute with your new Google Maps
  API key.

<meta-data
android:name="com.google.android.geo.API_KEY" ...> android:value="YOUR_API_KEY_HERE" /...>

6.2. For iOS::

• 6.2.1. Open your Flutter project in a text editor or IDE.
• 6.2.2. Navigate to the ios/Runner directory within your Flutter project.
• 6.2.3. Locate the AppDelegate.swift file.
• 6.2.4. In the didFinishLaunchingWithOptions method, set the Google Maps API key.

Replace “YOUR_API_KEY_HERE” with your actual Google Maps API key.

After updating the API key in the AppDelegate.swift file, rebuild your Flutter app for iOS to apply the changes.

By following these steps, your Flutter app will use the new Google Maps API key specifically for iOS. Make sure you’ve also updated the API key in the Android configuration as described earlier if you want to apply changes to both platforms.

7. Two Ways to set up a firebase with an application(Using Firebase CLI (5.1) OR Manually(5.2)).

7.1. Setting up Firebase for a Flutter project using the Firebase CLI involves several steps. Below is a detailed guide on how to do it:

7.1.1. Install Firebase CLI:

First, you need to install the Firebase CLI if you haven’t already. You can install it via npm (Node Package Manager) by running the following command in your terminal or command prompt:

7.1.2. Login to Firebase:

After installing the Firebase CLI, log in to your Firebase account by running the following command:

This will open a browser window prompting you to log in to your Google account associated with Firebase.

7.1.3. Create a Firebase Project:

If you haven’t already created a Firebase project, you can create one using the Firebase CLI by running:

Follow the prompts to create a new project.

7.1.4. Initialize Firebase in Your Flutter Project:

Navigate to your Flutter project directory in the terminal.

Initialize Firebase in your project by running:

This command will prompt you to select the Firebase features you want to set up. Choose the Firebase services you intend to use, such as Authentication, Firestore, etc.

7.1.5. Configure Firebase:

During the initialization process (firebase init), you’ll be asked to select the Firebase project you created or configured earlier.

Choose the appropriate project from the list.

7.1.6. Install Required Dependencies:

After selecting the Firebase features, Firebase CLI will generate the necessary configuration files for your project.

Next, you need to install the required Firebase packages in your Flutter project. You can do this by adding the dependencies to your pubspec.yaml file:

Replace latest_version with the actual version numbers of the Firebase plugins you want to use. You can find the latest versions on pub.dev.

7.1.7. Initialize Firebase in Your Flutter App:

7.1.8. Using Firebase Services:

Now you can use Firebase services in your Flutter app. Import the necessary Firebase packages and follow the respective documentation for each service you want to use (e.g., Firebase Authentication, Cloud Firestore).

7.1.9. Testing:

Run your Flutter app on a device or emulator to verify that Firebase services are correctly integrated and working.

7.2. Configuring and setting up FlutterFire in your Flutter project involves several steps. Here’s a detailed guide on how to do it:

7.2.1. Create a Firebase Project:

Go to the Firebase Console: https://console.firebase.google.com/

Click on “Add Project” and follow the instructions to create a new project.

Once your project is created, you’ll be redirected to the project dashboard.

7.2.2. Add an App to Your Firebase Project:

In the Firebase console, select your project.

Click on the “Add app” button (usually represented by an Android or iOS icon).

Follow the setup instructions to register your app with Firebase.

Download the google-services.json file for Android or GoogleService-Info.plist file for iOS. These files contain your Firebase project configuration details.

7.2.3. To update the DefaultFirebaseOptions in your Flutter project based on the google-services.json file, follow these steps:

7.2.3.1. Open your lib/firebase_options.dart file.

7.2.3.2. Extract the necessary keys from your google-services.json file, especially fields like apiKey, projectId, appId, etc.

7.2.3.3. Modify the DefaultFirebaseOptions class with the appropriate configuration for each platform.

7.2.4. Flutter Project Setup:

Open your Flutter project in your preferred editor.

Navigate to the android/app directory for Android or ios/Runner directory for iOS, and paste the google-services.json (for Android) or GoogleService-Info.plist (for iOS) file that you
downloaded earlier.

7.2.5. Add Firebase SDK to Your Flutter Project:

Open your Flutter project’s pubspec.yaml file.

Add the following dependencies:

Replace latest_version with the latest version numbers of the Firebase plugins you want to use. You can find the latest versions on pub.dev.

7.2.6. Using Firebase Services:

You can now use Firebase services in your Flutter app. Import the necessary Firebase packages and follow the respective documentation for each service you want to use (e.g., Firebase Authentication, Cloud Firestore).

7.2.7. Testing:

Run your Flutter app on a device or emulator to verify that Firebase services are correctly integrated and working.

8. To generate SHA-1 and SHA-256 keys for your Flutter app and add them to your Firebase project, you can follow these steps:

8.1. Using Keytool:

8.1.1. Navigate to your JDK’s bin directory in the command line.

8.1.2. Execute the following command to generate the SHA-1 key:

8.1.3. Replace path-to-your-keystore-file with the path to your keystore file (usually debug.keystore for debug builds and a custom keystore for release builds) and your-alias-name with the alias name used to generate the keystore.

8.1.4. Similarly, execute the following command to generate the SHA-256
key:

8.2. Using Gradle (Android Studio):

8.2.1. Open your Flutter project in Android Studio.

8.2.2. In the Android view, navigate to app -> Gradle Scripts -> build.gradle (Module: app).

8.2.3. Add the following lines to the android block

8.2.4. Replace path-to-debug.keystore, password, and key-alias with your keystore file path, password, and key alias respectively.

8.2.5. Sync your project to apply changes.

8.2.6. Run the following Gradle task in the terminal to get the SHA-1 and SHA-256 keys

8.3. Adding Keys to Firebase Console:

8.3.1. Go to the Firebase Console.

8.3.2. Select your project.

8.3.3. For Android:

• 8.3.3.1. Click on the Android icon to add an Android app.
• 8.3.3.2. Follow the setup instructions, including adding the google-services.json file to your Flutter project’s android/app directory.
• 8.3.3.3. During setup, you’ll be asked for your SHA-1 key. Paste the SHA-1 key you generated earlier.
• 8.3.3.4. After setup is complete, you’ll have the option to download the google-services.json file again. Replace the existing file in your project if needed.

8.3.4. For IOS:

• 8.3.4.1. Click on the iOS icon to add an iOS app.
• 8.3.4.2. Follow the setup instructions, including downloading the GoogleService-Info.plist file.
• 8.3.4.3. There’s no need to add SHA-1 or SHA-256 keys for iOS.
• 8.3.4.4. Add the downloaded GoogleService-Info.plist file to your Flutter project’s ios/Runner directory.

9.1. What should I do if I get the error message “Missing project_info object” in my Flutter project?

The error message you’re encountering, “Missing project_info object,” typically arises in Flutter projects when there’s a misconfiguration or missing information related to Firebase services. Here’s how you can troubleshoot and potentially resolve this issue.

Solution :

• 9.1.1. Check google-services.json: If you’re using Firebase services in your Flutter app, ensure that you have the google-services.json file placed in the correct location within your Android project. This file contains important configuration information for Firebase services. It should be located in the android/app directory of your Flutter project.
• 9.1.2. Verify Firebase Setup: Double-check that you’ve completed all the necessary steps to set up Firebase for your Flutter project. This includes adding your app to the Firebase project using the Firebase Console, downloading and adding the google-services.json file to your Android project, and configuring Firebase services in your Flutter app’s code (if applicable).
• 9.1.3. Update Google Services Plugin: Ensure that you’re using the latest version of the Google Services Gradle plugin in your Android project. You can check the latest version on the Google Services Gradle Plugin page and update the version number in your android/build.gradle file accordingly.
• 9.1.4. Check Flutter and Firebase Versions Compatibility: Make sure that you’re using compatible versions of Flutter and Firebase. Sometimes, using outdated versions of either can lead to compatibility issues. Refer to the Firebase Flutter documentation and ensure compatibility with your Flutter version.
• 9.1.5. Sync Gradle Files: After making any changes to your Android project configuration, such as updating the google-services.json file or modifying the Gradle build files, make sure to sync your Gradle files in Android Studio. This can be done by clicking on the “Sync Project with Gradle Files” button.
• 9.1.6. Rebuild the Project: After ensuring all configurations are correct, try rebuilding your Flutter project. You can do this by running flutter clean followed by flutter pub get and then rebuilding the project (flutter run or flutter build).
• 9.1.7. Check for Error Logs: Look for more detailed error messages or stack traces in the console output or build logs. These can provide additional clues about the underlying issue causing the “Missing project_info object” error.

3. Create Firebase Project

3.1 : Go to firebase console through this link: https://firebase.google.com

3.2 : Click on “Go to console” in the top right corner.

3.3 : Click on “Add project”, it will redirect you to the new project creation page Enter your project name and click on “Continue” again click on “Continue” after that select “Default Account fo firebase” and then click on “Create Project”

3.4 : After successfully creating a new project, you will be directed to the overview page. From there, simply navigate to the icons link to proceed further.

Upon redirection, you’ll land on the ‘Add Firebase to your web app’ page. Here, input your app’s nickname and proceed by clicking ‘Register app’. Afterward, scroll down to find detailed information as outlined below.

All of these details will be incorporated into both the app and admin panel documentation for comprehensive reference and seamless integration.

3.5 : Next, navigate to ‘Firestore Database’ in the left sidebar. Select your project name from the drop-down menu, and then proceed by clicking on ‘Create database’.

3.6 : Choose your preferred option and click on the ‘Next’ button. Subsequently, proceed by clicking on “Enable”

3.7 : Following that, locate “Realtime Database” in the left sidebar. Select your project name from the drop-down menu, and proceed by clicking on “Create Database”

3.8 : Choose your preferred option and proceed by clicking the “Next” button, then click on “Enable” to activate the selected feature.

3.9 : Firstore Database Rules Update.

Step 10: Upgrade your firebase plan.

See Video :

4. Firestore Database Collection Import Export

To perform Firebase Collection Import Export, follow these straightforward steps:

4.1 : To set up NPM on your computer, download Node.js from the following link: https://nodejs.org/en/download/ Node.js Download Page.

4.2 : Unzip the source code file named “Firebase Import Export Collections.zip”

4.3 : If you haven’t already created a Firebase project, set it up now.

4.4 : Configure the credentials.json file, which you can obtain from your Firebase Project settings. Then navigate to the Service account, then select Node.js. Generate a new private key and wait until the key is created. It will automatically download and replace the current credentials.json file.

4.5 : Navigate to the extracted Firebase Import Export Collections zip file path and then press and hold the Ctrl+Shift buttons. While holding them, right-click the mouse button, and select “Open PowerShell window here” from the context menu. This will open a PowerShell window where you can run the import/export command.

4.6 : Execute the following commands to perform import/export operations for collections:

To import all collections, execute the following command:

To export all collections, execute the following command:

Once the export command is executed, the collections.json file will be downloaded.

See Video:

5. Order Tracking & Delivery Dispatching

5.1 : The customer initiates a new order

5.2 : The store approves/rejects the new order

5.3 : If the store accepts the order, it is assigned to a nearby available driver.

5.4 : The driver can choose to either accept or decline the order. If the driver accepts the order, they are assigned to pick up and deliver the items.

5.5 : The driver arrives at the store to collect the order. Once picked up, the driver updates the order status in the app for the customer. After delivery, the driver can mark the order as completed in the driver app.

5.6 : If the driver rejects the order, the dispatch process restarts to find another available driver nearby.

5.7 : Customers can track the delivery status of all their orders on their delivery app. The app utilizes Flutter code to handle most order updates. However, the backend system, which manages access to all available nearby drivers and stores, facilitates the delivery process.

6. Deploy Firebase Cloud Functions

All the necessary Firebase Functions have been initially coded by us, you just need to deploy these functions to your own Firebase account. This means that you need to upload the source code inside the Firebase Functions folder to your account. If a Firebase account has been created, find a Firebase project, and 2 apps (iOS and Android).

6.1 : Setting up Node.js and the Firebase CLI

For comprehensive guidance, refer to the official Firebase documentation on getting started: “Write, test, and deploy your first functions” in Cloud Functions for Firebase.

You’ll need Node.js and the Firebase CLI to write functions and deploy them to Cloud Functions.

To set up NPM on your computer, download Node.js from the following link: Node.js download. Once Node.js is installed, proceed to install the Firebase CLI.

Use the following command to install the CLI via npm:

If you’ve already set up the Firebase tools, you can simply run the following command:

These steps will ensure you’re ready to start writing and deploying functions with Firebase. If you encounter any issues, consult the Firebase documentation for troubleshooting assistance.

6.2 : Initialize your project

To initialize the project, authenticate the Firebase tool by running the following command. You’ll be prompted to log in to your account via your web browser:

6.3 : Implementing Cloud Functions

Since we’re providing the complete source code for your Firebase Cloud Functions:

Extract the zip file Order Tracking Firebase Function folder.zip.

Fill in the necessary credentials in the following files located within the zip:

1. .firebaserc (Add your Firestore Project ID)

2. index.js (Add your Firestore database URL)

3. serviceAccountKey.json (Add your Firebase service account credentials)

With these steps, you’ve successfully set up the required credentials.

6.4 : Deploy Firebase Functions

Simply run the following command in the Order Tracking Firebase Function > functions directory.

Now you can go to your Firebase Console and check, as the functions have been deployed. It is possible to see the logs for each function, understand the output, and know when it gets called.

See Video:

7. Demo User Authentication Import

7.1 : Get files from the source zip

7.2 : Get serviceAccountKey.json from firebase configuration

7.3 :

7.4 : Run command

You can see the process of importing users in the firestore.

8. Firestore Database Indexing

To perform Firebase indexing, follow these straightforward steps:

8.1 : To set up NPM on your computer, download Node.js from the following link:https://nodejs.org/en/download/

8.2 : Unzip the source code file named “Firebase Indexing.zip” here.

8.3 : Navigate to the extracted directory of “Firebase Indexing” zip file. Press and hold the ctrl+shift buttons, then right-click the mouse button. From the context menu, select “Open PowerShell window here” to launch Windows PowerShell and execute import/export commands.

8.4 : Execute the command firebase login to log in to Firebase, if you haven’t already done so.

8.5 : Execute the command firebase init

8.6 : Proceed with Y and press the enter button.

8.7 : Choose the Option > Firestore: Configure security rules and index files for Firestore.

8.8 : Choose the Option > Use an existing project

8.9 : Choose your project

8.10 : Press Enter > ? What file should be used for Firestore Rules? firestore.rules

8.11 : Press Enter > ? What file should be used for Firestore indexes? (firestore.indexes.json)

8.12 : Now, the firestore.indexes.json file will be downloaded. Open this file and copy all the code from firestore_indexes.json file, then paste it into
firestore.indexes.json file.

8.13 : Now execute the command firebase deploy --only firestore:indexes to import indexing in firestore.

See Video:

9. Admin Panel Setup

Ensure that your server meets the requirements outlined in the documentation’s Server Requirement section. Upon downloading the code, upload the admin zip file to your server and extract it. The admin panel can be installed on either a domain or a subdomain.

9.1 Create Database

9.1.1 : Create a new database from your server’s MYSQL database.

9.1.2 : Create New Database

9.1.3 : Create a new database user

9.1.4 : Connect the database to the newly created database user.

9.1.5 : Grant all privileges to your user by selecting “All PRIVILEGES” and then clicking on “Make Changes”

9.2 Configure Admin Panel

9.2.1 : Once you’ve downloaded the code, upload the admin zip file to your server and extract it. The admin panel can be installed on either a domain or subdomain.

9.2.2 : Next, you’ll need to configure the following settings in your .env file: Database host, Database name, Database username, Database password, and your Firebase project credentials.

To obtain Firebase credentials, navigate to Project Settings > General >
Web apps, then select your web app.

9.2.3 : Import the provided foodie_admin_database.sql file to initialize the database.

9.2.4 : Now the admin panel is ready to run.

9.2.5: Important: To work firebase push notification feature functions correctly, please upload your Firebase credentials file in the Admin Panel by navigating to Settings > Global Settings > Notifications Settings.

9.2.6: Enable withdrawal method option to allow payment method as a withdrawal method for restaurant/driver payouts by navigating to Settings > Payment Methods.

9.2.7: Please set up your preferred delivery zone by navigating to Zone menu

10. Website Panel Setup

10.1 : Once you’ve downloaded the code, upload the web panel zip file to your server and extract it. You can install the web panel on your main domain.

10.2 : Now you’ll need to configure the .env file with your Database host, Database name, Database username, Database password, and your Firebase project credentials.

10.3 : Import the provided gromart_website_database.sql file to import the database.

10.4 : Now the website panel is ready to run.

11. Store Panel Setup

11.1 : Once you’ve downloaded the code, upload the store panel zip file to your server and extract it. You can install the web panel on your main domain or subdomain.

11.2 : Now you’ll need to configure the .env file with your Database host, Database name, Database username, Database password, and your Firebase project credentials.

11.3 : Import the provided gromart_store_database.sql file to import the database.

11.4 : Now the store panel is ready to run.