This document provides comprehensive guidance for setting up and configuring the development environment for the Flutter Mobile Project Template. It covers required tools, IDE configurations, and build environments to ensure a consistent development experience across the team.
The project has specific version requirements to ensure consistency:
| Tool | Required Version | Purpose |
|---|---|---|
| Flutter | ^3.27.1 | SDK for building the application |
| Dart | ^3.6.0 | Programming language |
| Melos | ^7.0.0-dev.7 | Monorepo management |
| Mason CLI | ^0.1.2 | Template scaffolding |
Sources: pubspec.yaml2-4 pubspec.yaml28-30
The project uses mise (a replacement for tools like asdf, nvm, etc.) to manage tool versions. VS Code is configured to use the Flutter and Dart SDK managed by mise.
Sources: .vscode/settings.json3-4 pubspec.yaml40-52
To set up the development environment:
mise use in the project root to install required toolsmelos bootstrap to set up the workspaceThe melos bootstrap command will:
Sources: pubspec.yaml72-74 pubspec.yaml76-82
The project supports both VS Code and IntelliJ IDEA with custom configurations.
VS Code is the primary IDE with detailed configuration provided:
The following extensions are recommended for VS Code:
| Extension ID | Purpose |
|---|---|
| dart-code.dart-code | Dart language support |
| dart-code.flutter | Flutter framework support |
| blaugold.melos-code | Melos integration |
| djbkwon.flutter-dependency-docs | Documentation for dependencies |
| esbenp.prettier-vscode | JSON formatting |
| DavidAnson.vscode-markdownlint | Markdown linting |
| google.arb-editor | ARB localization editor |
Sources: .vscode/extensions.json2-11
VS Code includes launch configurations for different environments:
| Configuration | Purpose | Arguments |
|---|---|---|
| dev-debug | Development environment | --dart-define-from-file=flavor/dev.json |
| stg-debug | Staging environment | --dart-define-from-file=flavor/stg.json |
| prd-debug | Production environment | --dart-define-from-file=flavor/prd.json |
| ui-catalog | UI component catalog | - |
| samples-github-app | GitHub sample app | - |
Sources: .vscode/launch.json6-50
IntelliJ IDEA is supported with specific run configurations:
The project includes the following run configurations for IntelliJ:
Note: Automatic Melos configuration in IntelliJ is disabled to support custom build environments.
Sources: pubspec.yaml42-46 .idea/runConfigurations/ui_catalog.xml1-7 .idea/runConfigurations/samples_github_app.xml1-6
The project uses environment-specific configurations to support different deployment targets.
The application supports three environments:
To launch the app with a specific environment flavor:
# Development
flutter run --dart-define-from-file=flavor/dev.json
# Staging
flutter run --dart-define-from-file=flavor/stg.json
# Production
flutter run --dart-define-from-file=flavor/prd.json
Sources: .vscode/launch.json8-35
The project uses Melos to manage the monorepo structure and provide useful commands for development tasks.
Sources: pubspec.yaml5-26
Melos provides a set of predefined commands to streamline development:
| Command | Description |
|---|---|
melos bootstrap | Set up workspace and install dependencies |
melos run gen | Generate code (build_runner and l10n) |
melos run fix | Apply Dart fixes to all packages |
melos run fix:custom | Apply custom lint fixes |
melos run test | Run all tests across packages |
melos run upgrade | Upgrade dart dependencies |
melos run golden_test | Update golden files for UI tests |
Sources: pubspec.yaml75-212
A typical development workflow using this template follows these steps:
melos bootstrap to initialize workspacemelos run gen for code generationmelos run test to verify changesmelos run fix to apply fixesSources: pubspec.yaml96-100 pubspec.yaml142-156
The project includes configuration for spell checking with cspell:
# Install dependencies
bun install
# Run spell checking
npx cspell "**/*.{dart,md,json,yaml}"
Sources: package.json2-8 bun.lock1-241
Mason CLI is used for code generation and scaffolding:
# Install mason
dart pub global activate mason_cli
# List available bricks
mason list
Sources: pubspec.yaml29 .gitignore14-19
This development environment is designed to ensure consistency across team members and simplify common development tasks. By following the setup instructions and using the provided tools, developers can work efficiently with this Flutter project template.
For information about CI/CD pipelines and automation, see CI/CD and Automation. For information about the application architecture, see Application Architecture.
Refresh this wiki