1. Getting started
To install and run Flutter, your development environment must meet these minimum requirements:
Operating Systems: Windows 7 SP1 or later (64-bit)
Disk Space: 400 MB (does not include disk space for IDE/tools).
Tools: Flutter depends on these tools being available in your environment.
Windows PowerShell 5.0 or newer (this is pre-installed with Windows 10)
Git for Windows 2.x, with the Use Git from the Windows Command Prompt option.
If Git for Windows is already installed, make sure you can run git commands from the command prompt or PowerShell.
Get Flutter SDK
- Download the latest installation bundle and choose the latest stable release of the Flutter SDK at flutter.dev
- Extract the zip file and the container flutter in the desired installation location for the Flutter SDK (for example, C:\src\flutter; do not install Flutter in a directory like C:\Program Files\ that requires elevated privileges).
If you don't want to install a fixed version of the installation bundle, you can skip steps 1 and 2. Instead, get the source code from the Flutter repo on GitHub,and change branches or tags as needed. For example:
git clone https://github.com/flutter/flutter.git -b stable
You are now ready to run flutter commands in the Flutter Console!
Update your path
If you wish to run Flutter commands in the regular Windows console, take these steps to add Flutter to the PATH environment variable:
- From the Start search bar, enter 'env' and select Edit environment variables for your account.
- Under User variables check if there is an entry called Path:
- If the entry exists, append the full path to futter\bin using ; as a separator from existing values.
- If the entry doesn't exist, create a new user variable named Path with the full path to flutter\bin as its value.
Note that you have to close and reopen any existing console windows for these changes to take effect.
Run 'flutter doctor'
From a console window that has the Flutter directory in the path (see above), run the following command to see if there are any platform dependencies you need to complete the setup:
C:\src\flutter> flutter doctor
This command check your environment and displays a report of the status of your Flutter installation. Check the output carefully for other software you might need to install or further tasks to perform (shown in bold text).
[-] Android toolchain - develop for Android devices
• Android SDK at D:\Android\sdk
✗ Android SDK is missing command line tools; download from https://goo.gl/XxQghQ
• Try re-installing or updating your Android SDK,
visit https://flutter.dev/setup/#android-setup for detailed instructions.
The following sections describe how to perform these tasks and finish the setup process. Once you have installed any missing dependencies, you can run the flutter doctor command again to verify that you've set everything up correctly.
Warning: the Flutter tool uses Google Analytics to anonymously report feature usage statistics and basic crash reports. This data is used to help improve Flutter tools over time.
Flutter tool analytics are not sent on the very first run. To disable reporting, type flutter config --no-analytics. To display the current setting, type flutter config. If you opt out of analytics, an opt-out event will be sent, and then no further information will be sent by the Flutter tool.
Moreover, Flutter includes the Dart SDK, which may send usage metrics and crash reports to Google.
Note: Flutter relies on a full installation of Android Studio to supply its Android platform dependencies. However, you can write your Flutter apps in a number of editors; a later step will discuss that.
Install Android Studio
- Download and install Android Studio.
- Start Android Studio, and go through the 'Android Studio Setup Wizard'. This install the latest Android SDK Command-line Tools, and Android SDK Build-Tools, which are required by Flutter when developing for Android.
Note: Flutter team is updating the flutter tool to use either the Platform-Tools (now obselete), or the new Command-Line tool if it is available.
Setup your Android device
To prepare to run and test your Flutter app on an Android device, you'll need an Android device running Android 4.1 (API level 16) or higher.
- Enable Developer options and USB Debugging on your device. Detailed instructions are available in the Android documentation.
- Windows-only: Install the Google USB Driver.
- Using a USB cable, plug your phone into a computer. If prompted on your device, authorize our computer to access your device.
- In the terminal, run the flutter devices command to verify that Flutter recognizes your connected Android device. By default, Flutter uses the version of the Android SDK where your adb tool is based. If you want Flutter to use a different installation of the Android SDK, you must set the ANDROID_HOME environment variable to that installation directory.
Set up the Android emulator
To prepare to run and test your Flutter app on the Android emulator, follow these steps:
- Enable VM acceleration on your machine.
- Launch Android Studio > Tools > Android > AVD Manager and select Create Virtual Device. (The Android submenu is only present when inside an Android project.)
- Choose a device definition and select Next.
- Select one or more system images for the Android versions you want to emulate, and select Next. An x86 or x86_64 image is recommended.
- Under Emulated Performance, select Hardware - GLES 2.0 to enable hardware acceleration.
- Verify the AVD configuration is correct, and select Finish.
- For details on the above steps, see Managing AVDs.
- In Android Virtual Device Manager, click Run in the toolbar. The emulator starts up and displays the default canvas for your selected OS version and device.
Set up an editor
You can build apps with Flutter using any text editor combined with its command-line tools. However, it's recommended to use one of the available editor plugins for an even better experience. These plugins provide you with code completion, syntax highlighting, widget editing assists, run & debug support, and more.
Follow the steps below to add an editor plugin for VSCode.
Setup Android Studio
Android Studio offers a complete, integrated IDE experience for Flutter. You should have this installed from the previous steps.
Install Flutter & Dart plugins
- Start Android Studio.
- Open plugin preferences (File > Preferences > Plugins)
- Select Marketplace, select the Flutter plugin and click Install.
- Click Yes when prompted to install the Dart plugin.
- Click Restart when prompted.
Install VS Code
VS Code is a lightweight editor with Flutter app execution and debug support.
Install Flutter & Dart extensions
- Start VS Code.
- Invoke View > Command Palette
- Type "install", and select "Extensions: Install Extensions"
- Type "flutter" in the extensions search field, select Flutter in the list, and click Install. This also installs the required Dart plugin.
Install Appframe API Explorer extension
You can install this extension via the Marketplace or a command line command.
- Press CTRL + SHIFT + X to open the marketplace in VSCode.
- Search for "Appframe Data API Explorer"
- Click install
- Command line
- code --install-extension omegaas.appframe-data-api-explorer
Validate your setup with Flutter Doctor
- Invoke View > Command Palette
- Type "doctor",and select the "Flutter: Run Flutter Doctor"
- Review the output in the OUTPUT pane for any issues.
Clone Appframe Flutter Foundation project
This part will cover how to access and clone the Appframe Flutter repository and start working on your first application.
The foundation application is a minimal starter project with Appframe Authentication and API packages setup and configured.
Run the following command from the desired directory for your project:
git clone https://email@example.com/OmegaAS/MobileTeam%20-%20Core/_git/AppframeProjectSkeleton
Post Clone setup
- Remove existing remote from the git repository with the following command:
$ rm -rf .git;
- Optionally run: git init to initialize a new git repository.