This document outlines the organization of the Flutter Mobile Project Template repository. It provides a comprehensive overview of the directory structure, explains the relationships between different packages, and describes the roles of each component. For information about how to get started with development, see Getting Started.
The repository is organized into several main directories that serve distinct purposes:
Sources: pubspec.yaml5-26 docs/ARCHITECTURE.md10-24
The apps directory contains standalone applications:
Main App (apps/app): The primary mobile application intended for end-users. It imports and uses functionality from the core and feature packages.
UI Catalog (apps/catalog): A dedicated application for showcasing and previewing UI components from the cores and features packages. This app is primarily used by developers and designers to visualize components in isolation.
Sources: apps/app/pubspec.yaml1-66 apps/catalog/pubspec.yaml1-33 apps/catalog/README.md1-31
The packages directory is organized into three main categories:
packages/cores/)Core packages provide fundamental capabilities used throughout the application. They implement base functionality that feature packages can build upon.
| Package | Description |
|---|---|
core | Foundation features for the app, including basic utilities and common functionality |
data | Data access layer with repositories and network clients |
designsystem | Style definitions, themes, and design tokens |
model | Data model classes used across the application |
ui | Shared UI components built on top of the design system |
packages/features/)Feature packages implement specific user-facing functionality. Each feature package is self-contained with its own UI, data access, and business logic.
| Package | Description |
|---|---|
debug_mode | Developer tools and debugging features |
force_update | Functionality to manage app version updates |
maintain | Maintenance mode implementation |
setting | Application settings and configuration |
webview | WebView functionality for rendering web content |
packages/utils/)Utility packages provide reusable functionality that doesn't fit into core or feature categories.
| Package | Description |
|---|---|
pagination | Utilities for handling paginated data |
Sources: pubspec.yaml10-26 packages/cores/data/pubspec.yaml1-30 packages/cores/designsystem/pubspec.yaml1-35 packages/cores/model/pubspec.yaml1-18 packages/cores/ui/pubspec.yaml1-29 packages/features/debug_mode/pubspec.yaml1-41 packages/features/force_update/pubspec.yaml1-36 packages/features/maintain/pubspec.yaml1-44 packages/features/setting/pubspec.yaml1-48 packages/utils/pagination/pubspec.yaml1-24
Each feature package follows a consistent internal structure to maintain organization and separation of concerns:
Sources: packages/features/setting/pubspec.yaml1-48 packages/features/debug_mode/pubspec.yaml1-41 packages/features/maintain/pubspec.yaml1-44
The project follows a structured dependency hierarchy to maintain proper architectural boundaries:
Key dependency rules:
This hierarchy prevents circular dependencies and ensures proper separation of concerns.
Sources: docs/ARCHITECTURE.md26-41 apps/app/pubspec.yaml13-30 packages/features/debug_mode/pubspec.yaml12-35 packages/features/setting/pubspec.yaml12-28 packages/features/force_update/pubspec.yaml12-24 packages/features/maintain/pubspec.yaml12-31
The tools directory contains development tools and code generation resources:
The tools directory includes:
Sources: pubspec.yaml28-30 tools/bricks/cores_package_dart/__brick__/packages/cores/{{package_name.snakeCase()}}/README.md1-40
The project uses Melos for managing the monorepo workspace. The workspace configuration is defined in the root pubspec.yaml file:
Key aspects of the workspace configuration:
Sources: pubspec.yaml4-26 pubspec.yaml40-226
The application supports multiple environments, each with its own set of configurations:
| Environment | Purpose | App ID Example |
|---|---|---|
| Dev | Development environment for ongoing development | jp.co.yumemi.template.dev |
| Stg | Staging environment for pre-release testing | jp.co.yumemi.template.stg |
| Prd | Production environment for end users | jp.co.yumemi.template |
Each environment has its own configuration for app name, app ID, and other environment-specific variables.
Sources: apps/app/README.md7-31
The Flutter Mobile Project Template follows a carefully structured approach to organizing code, with clear separation between apps, core packages, feature packages, and utilities. This structure promotes:
This organization reflects modern architectural principles for mobile app development, ensuring the codebase remains manageable as the application grows in complexity.
Refresh this wiki