Getting Started (Build & Run)

Follow below steps to build and run your application.

Download Project

Download and find the your project folder, use your preferred IDE (Android Studio / Visual Studio Code / IntelliJ IDEA) to run the project.

Project Structure Documentation

This document outlines the folder and file structure of the project, explaining the purpose of each major component.

Root Directory

• analysis_options.yaml: Configures the Dart static analyzer to enforce code style, identify potential bugs, and ensure code quality.
• flutter_launcher_icons.yaml: Configuration file for the flutter_launcher_icons package, used to generate app launcher icons for different platforms from a single source image.
• pubspec.yaml: The project's manifest file. It defines project metadata, dependencies (packages), and assets (images, fonts, etc.). This is a key configuration file for any Flutter project.
• README.md: A Markdown file containing introductory information about the project.

Core Application Code (lib/)

This is where all the Dart code for the application resides.

• lib/main.dart: The entry point of the Flutter application.
• lib/app/: Contains core application setup and configuration.
  • theme/: Theming and styling logic (e.g., colors, text styles).
  • view/: Core app widgets and views.
• lib/core/: Shared utilities, constants, and core functionalities used across the application.
  • constants/: Application-wide constants (e.g., API endpoints, keys, default values).
  • utils/: Utility functions and helper classes (e.g., formatters, validators).
• lib/generated/: Auto-generated files, typically from code generation packages. Do not edit these manually.
  • codegen_loader.g.dart: Generated for the easy_localization package for loading translation assets.
  • locale_keys.g.dart: Generated keys for localized strings, providing type-safe access.
• lib/model/: Data model classes that define the structure of data used in the app (e.g., User, Product, Order).
• lib/router/: Navigation and routing logic.
  • app_router.dart: Defines the application's routes and navigation setup, likely using the auto_route package.
  • app_router.gr.dart: Auto-generated file by auto_route containing the actual router implementation.
• lib/service/: Business logic and services that interact with data sources or external APIs.
  • service_locator.dart: Sets up dependency injection (e.g., using get_it) to provide services throughout the app.
  • theme_service.dart, theme_service_hive.dart: Services for managing and persisting the application's theme.
  • toast_service.dart: A utility service for showing notifications (toasts) to the user.
• lib/ui/: Contains all the UI components of the application.
  • screen/: Top-level widgets, where each file typically represents a full screen or page in the app.
  • widget/: Reusable UI components (widgets) that are used across multiple screens (e.g., custom buttons, cards, dialogs).

Platform-Specific Folders

These folders contain the native project wrappers for each platform that Flutter supports.

• android/: Contains the native Android project. You edit files here to configure Android-specific settings like permissions in AndroidManifest.xml or build settings in build.gradle.
• ios/: Contains the native iOS project. You edit files here to configure iOS-specific settings in Info.plist or manage dependencies with Podfile.
• linux/: Contains the native Linux desktop project.
• macos/: Contains the native macOS desktop project.
• windows/: Contains the native Windows desktop project.
• web/: Contains the files for the web version of the application, including index.html and the favicon.

Assets

• assets/: Static assets used by the application.
  • fonts/: Custom font files.
  • google_fonts/: Cached Google Fonts for offline use.
  • images/: Image files (e.g., .png, .jpg).
  • svgs/: SVG vector image files.
  • translations/: JSON files for localization, containing key-value pairs for different languages.

Test

• test/: Contains automated tests for your application (e.g., unit tests, widget tests).

Get Dependencies

After you loaded project successfully, run the following command in the terminal to install all the dependencies listed in the pubspec.yaml file in the project’s root directory or just click on Pub get in pubspec.yaml file if you don’t want to use command.

flutter pub get

Build and Run App

After the app build completes, you’ll see the app on your device.

If you don’t use Android Studio or IntelliJ you can use the command line to run your application using the following command

flutter run

You will see below like screen after you have build your app successfully