ScanEat Documentation

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

1.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.

1.2. Install Flutter SDK:

Download the Flutter SDK from the official Flutter website.

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.

1.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.

1.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.

1.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.

1.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.

1.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.

1.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.

1.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.

2. 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:

2.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.

2.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.

2.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.

2.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.

2.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.

2.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.

2.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.

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

3.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).

3.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.

3.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.

4. 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:

4.1. For Android:

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

4.2. For iOS:

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

4.3. For Web:

• 4.3.1. Open the web/index.html file.
• 4.3.2. Locate the <key>title</key> tag.
• 4.3.3. Change the text within the <title> tag to your desired app name.

4.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.

4.5. Example:

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

4.5.1. Android:

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

4.5.2. iOS:

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

4.5.3. Web:

<title>My New App</title>

4.5.4. Pubspec.yaml:

name: my_new_app

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

5.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:

5.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:

npm install -g firebase-tools

5.1.2. Login to Firebase:

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

firebase login

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

5.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:

firebase projects:create

Follow the prompts to create a new project.

5.1.4. Initialize Firebase in Your Flutter Project:

Navigate to your Flutter project directory in the terminal.

Initialize Firebase in your project by running:

firebase init:create

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.

5.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.

5.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:

dependencies:
  firebase_core: latest_version
  firebase_auth: latest_version  # (if you need Firebase Authentication) cloud_firestore: latest_version # (if you need Cloud Firestore) # Add other Firebase plugins as needed

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.

5.1.7. Initialize Firebase in Your Flutter App:

import 'package:firebase_core/firebase_core.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await Firebase.initializeApp();
  runApp(MyApp());
}

5.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).

5.1.9. Testing:

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

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

5.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.

5.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.

5.2.3. 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.

5.2.4. Add Firebase SDK to Your Flutter Project:

Open your Flutter project’s pubspec.yaml file.

Add the following dependencies:

dependencies:
  flutter:
    sdk: flutter
  firebase_core: latest_version
  firebase_auth: latest_version  # (if you need Firebase Authentication)

cloud_firestore: latest_version  # (if you need Cloud Firestore)
  # Add other Firebase plugins as needed

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.

5.2.5. 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).

5.2.6. Testing:

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

6. How to import data from Cloud File to Firestore?

• 6.1. Generate a private key file for your service account. In the Firebase console, open Settings > Service Accounts.
• 6.2. Click Generate New Private Key, then confirm by clicking Generate Key.
• 6.3. Rename the JSON file to credentials.json.
• 6.4. Go to the “database” folder in the given source code.
• 6.5. Past credentials.json in database folder and replace with our existing credentials.json file.

6.6. You could also use this to import data to Firestore using below command:

npx -p node-firestore-import-export firestore-import -a credentials.json -b backup.json

7. How to import indexing?

• 7.1. Go to the scaneats_admin folder.
• 7.2. Open terminal.
• 7.3. Use below code to setup firebase

firebase init

• 7.4. Select a default Firebase project
• 7.5. Select Functions: Configure a Cloud Functions directory and its files
• 7.6. After completing All the process.
• 7.7. You could also use this to import indexing to Firestore using below command:

firebase deploy --only firestore:indexes

8. To change the favicon (favourite icon) in a Flutter web application, you need to modify the HTML file that serves as the entry point for your Flutter web app. Here’s how you can do it:

8.1. Locate the index.html file:

In your Flutter web project, navigate to the web directory. Inside this directory, you’ll find the index.html file. This file is the entry point for your Flutter web application.

8.2. Replace the default favicon:

You can replace the default favicon with your custom favicon by adding a <link> tag within thesection of the index.html file. Here’s an example of how you can do it:

<!DOCTYPE html>
<html>
<head>
  <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>My Flutter Web App</title><!-- Replace the default favicon with your custom favicon --> <link rel="icon" href="assets/my_custom_favicon.ico" type="image/x-icon"> </head> <body> <!-- Your Flutter app will be rendered here --> <script src="main.dart.js" type="application/javascript"></script> </body> </html>

In the <link> tag, set the href attribute to the path of your custom favicon file. Make sure to replace "assets/my_custom_favicon.ico" with the actual path to your custom favicon file.

8.3. Update the Flutter Web Build:

After modifying the index.html file, you need to rebuild your Flutter web application to apply the changes. Run the following command in your terminal:

flutter build web --web-renderer html

8.4. View Your Application:

Once the build process is complete, open your web browser and navigate to the URL where your Flutter web application is hosted. You should see your custom favicon displayed in the browser tab.

9. To run a Flutter web application using the command line, follow these steps:

9.1. Command-Line Flag:

During development, use the flutter run command with the --web-renderer html flag:

flutter run -d chrome --web-renderer html

For building a release version:

flutter build web --web-renderer html

10. Please update the website URL application path in the file lib/constant/constant.dart as follows:

static String adminWebSite = "https://New_admin_domain/";static String customerWebSite = "https://New_customer_domain/";

Ensure to replace “New_admin_domain” with the appropriate domain for the admin website and “New_customer_domain” with the correct domain for the customer website.

11. To upload a Flutter web application to a server, you typically need to follow these steps :

11.1. Build your Flutter web application:

11.1.1. Ensure your Flutter web application is ready for deployment by testing it locally.

11.1.1. Run flutter build web --web-renderer html in your project directory. This command generates the necessary web assets in the build/web directory.

flutter build web --web-renderer html

11.2. Choose a hosting provider:

11.2.1. You need a server where you can host your web application. This could be a cloud service like AWS, Google Cloud Platform, or a shared hosting provider.

11.3. Prepare your server:

11.3.1. If you’re using a cloud service, follow their instructions for deploying a web application.

11.3.2. If you’re using a shared hosting provider, you’ll typically need to use FTP or SSH to upload your files to the server. Make sure your hosting plan supports serving static web files.

11.4. Upload your files:

11.4.1. Transfer the contents of the build/web directory to your server.

11.4.2. You can use FTP clients like FileZilla or command-line tools like SCP to transfer files.

11.5. Configure your server:

11.5.1. Make sure your server is configured to serve web content from the directory where you uploaded your Flutter web application.

11.5.2. If you’re using a cloud service, you may need to configure your domain to point to your server.

11.6. Test your deployed application:

11.6.1. Visit your website’s URL in a web browser to ensure your Flutter web application is being served correctly.

11.6.2. Check for any errors or issues that may have occurred during deployment.

11.7. Maintenance and updates:

11.7.1. Keep your server and application updated with any security patches or new releases.

11.7.2. Monitor your application’s performance and address any issues that arise.