Flutter project structure

Introduction

Knowing the Flutter project structure helps you find and organize your app files easily.

When you start a new Flutter app and want to understand where to put your code.

When you want to add images or fonts to your app.

When you need to change app settings like name or icon.

When you want to add packages or plugins to your project.

When you want to run or build your app on different devices.

Syntax

Flutter

my_flutter_app/
  android/
  ios/
  lib/
  test/
  pubspec.yaml
  README.md
  .gitignore

lib/ is where your Dart code lives, especially main.dart.

pubspec.yaml manages app info, dependencies, and assets.

Examples

Organize your Dart code inside lib/ with folders for screens and widgets.

Flutter

lib/
  main.dart
  screens/
  widgets/

This file lists packages your app uses, like icons.

Flutter

pubspec.yaml
  dependencies:
    flutter:
      sdk: flutter
    cupertino_icons: ^1.0.2

Android-specific files and settings are inside the android/ folder.

Flutter

android/
  app/
    src/
      main/
        AndroidManifest.xml

iOS-specific files and settings are inside the ios/ folder.

Flutter

ios/
  Runner.xcodeproj
  Runner/
    Info.plist

Sample App

This simple app shows text on the screen. It lives inside the lib/main.dart file in your Flutter project.

Flutter

import 'package:flutter/material.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return const MaterialApp(
      home: Scaffold(
        body: Center(
          child: Text('Hello Flutter Project Structure!'),
        ),
      ),
    );
  }
}

Important Notes

Always keep your Dart code inside the lib/ folder.

Use pubspec.yaml to add images, fonts, and packages.

Folders android/ and ios/ contain platform-specific code and settings.

Summary

The Flutter project has folders for code (lib/), platform files (android/, ios/), and tests (test/).

pubspec.yaml manages app info, dependencies, and assets.

Understanding this structure helps you build and organize your app smoothly.

Practice

1. Which folder in a Flutter project contains the main Dart code for your app?

easy

A. lib/

B. android/

C. ios/

D. test/

Solution

1. Step 1: Identify the folder purpose

   The lib/ folder is where Dart code for the app lives.

2. Step 2: Compare with other folders

   android/ and ios/ hold platform-specific files, test/ holds tests.

3. Final Answer:

   lib/ -> Option A

4. Quick Check:

   Main Dart code folder = lib/ [OK]

Hint: Main app code is always in lib/ folder [OK]

Common Mistakes:

• Confusing android/ with code folder
• Thinking test/ holds main code
• Mixing ios/ with Dart code

2. Which file manages app dependencies and assets in a Flutter project?

easy

A. main.dart

B. pubspec.yaml

C. build.gradle

D. AndroidManifest.xml

Solution

1. Step 1: Understand file roles

   pubspec.yaml is the config file for dependencies and assets.

2. Step 2: Differentiate from other files

   main.dart is code, build.gradle is Android build config, AndroidManifest.xml is Android app manifest.

3. Final Answer:

   pubspec.yaml -> Option B

4. Quick Check:

   Dependencies and assets file = pubspec.yaml [OK]

Hint: pubspec.yaml always manages dependencies and assets [OK]

Common Mistakes:

• Choosing main.dart as config file
• Confusing build.gradle with Flutter config
• Mixing AndroidManifest.xml with Flutter dependencies

3. What will happen if you put your test files inside the lib/ folder instead of test/?

medium

A. Tests will automatically move to test/ folder

B. Tests will run normally without issues

C. App will fail to compile due to test files

D. Tests may be included in the app build, increasing size

Solution

1. Step 1: Understand folder roles

   lib/ is for app code; test/ is for tests only.

2. Step 2: Consequence of wrong placement

   Putting tests in lib/ includes them in app build, increasing size unnecessarily.

3. Final Answer:

   Tests may be included in the app build, increasing size -> Option D

4. Quick Check:

   Tests in lib/ increase app size [OK]

Hint: Keep tests only in test/ folder to avoid bloated app [OK]

Common Mistakes:

• Assuming tests run normally in lib/
• Thinking app will fail to compile
• Believing tests auto-move folders

4. You accidentally deleted the android/ folder in your Flutter project. What is the likely result?

medium

A. The iOS build will fail instead

B. The app will still build and run on Android devices

C. You will get errors when building for Android platform

D. Flutter will recreate the android/ folder automatically

Solution

1. Step 1: Role of android/ folder

   The android/ folder contains platform-specific files needed to build Android apps.

2. Step 2: Effect of deletion

   Deleting it causes build errors when targeting Android because required files are missing.

3. Final Answer:

   You will get errors when building for Android platform -> Option C

4. Quick Check:

   Missing android/ folder causes Android build errors [OK]

Hint: android/ folder is essential for Android builds [OK]

Common Mistakes:

• Assuming app runs without android/ folder
• Thinking iOS build is affected
• Believing Flutter auto-recreates android/

5. You want to add a new image asset to your Flutter app. Which two steps must you do to use it correctly?

hard

A. Place the image in assets/ folder and declare it in pubspec.yaml

B. Place the image in android/ folder and import it in main.dart

C. Place the image in lib/ and add it to pubspec.yaml

D. Place the image in test/ folder and reference it in code

Solution

1. Step 1: Store image in assets/ folder

   Images should be placed in a dedicated folder like assets/ for organization.

2. Step 2: Declare asset in pubspec.yaml

   You must list the image path under flutter/assets in pubspec.yaml to use it.

3. Final Answer:

   Place the image in assets/ folder and declare it in pubspec.yaml -> Option A

4. Quick Check:

   Assets folder + pubspec.yaml declaration = correct asset use [OK]

Hint: Always declare assets in pubspec.yaml after adding files [OK]

Common Mistakes:

• Putting images in lib/ folder
• Not declaring assets in pubspec.yaml
• Placing images in android/ or test/ folders