Flutter
(Please remember, Flutter is in technology preview. Thanks
for trying it out, and please don’t hesitate to
file issues or bugs
for us.)
This guide describes how to set up your development environment to run Flutter apps on
iOS or Android.
System requirements
To install and run Flutter, your development environment must meet these minimum requirements:
- Operating Systems: Mac or Linux (64-bit). Windows support is planned.
- Tools: Flutter depends on these command-line tools being available on your environment.
bash,mkdir,rm,git,curl,unzip
Get the Flutter SDK
To get Flutter, use git to clone the repository and then add the flutter tool to your path:
$ git clone https://github.com/flutter/flutter.git -b alpha $ export PATH=`pwd`/flutter/bin:$PATH
Run the following command to see if there are any dependencies you need to install to complete
the setup:
1 | $ flutter doctor
|
The first time your run the flutter command, it will download its dependencies and compile
itself. Subsequent runs should be much faster.
Once you have installed any missing dependencies, run the flutter doctor command again to
verify that you’ve set everything up correctly.
iOS setup
This step is optional, and can be performed at any time before
using Flutter to develop apps for iOS.
To develop Flutter apps for iOS, you need a Mac with Xcode 7.2 or newer:
- Install Xcode 7.2 or newer (via web download or
the Mac App Store). - Make sure the Xcode EULA is signed by either opening Xcode once and confirming or
runningsudo xcodebuild -licensefrom the command-line.
With Xcode, you’ll be able to run Flutter apps on the iOS simulator.
Set up the iOS simulator
To prepare to run and test your Flutter app on the iOS simulator, follow these steps:
- On your Mac, find the Simulator via Spotlight or by using the following command:
1 | $ open -a Simulator |
- Make sure your simulator is using a 64-bit device (iPhone 5s or later) by checking the settings
in the simulator’s Hardware > Device menu. - Depending on your development machine’s screen size, simulated high-screen-density iOS devices
may overflow your screen. Set the device scale under the Window > Scale menu in the simulator.
Deploy to iOS devices
To deploy your Flutter app to a physical iOS device, you’ll need some additional tools:
- Install homebrew.
Open the terminal and run these command to install the toools for deploying Flutter apps to
iOS devices.$ brew tap flutter/flutter $ brew install ideviceinstaller ios-deploy
Android setup
To develop Flutter apps for Android, you can use either a Mac or a Linux (64-bit) machine:
- Install Android Studio.
- From Android Studio, install the latest Android SDK and Android SDK Platform-Tools, as described
in Adding SDK Packages.
Set up your Android device
To prepare to run and test your Flutter app on Android, you’ll need an Android device running
Android 4.1 (API level 16) or higher.
- Enable developer mode on your device by visiting
Settings > About phoneand
tapping theBuild numberline seven times. - Enable
Android debugginginSettings > Developer options. - Using a USB cable, plug your phone into your computer. If prompted on your
device, authorize your computer to access your device. - In the terminal, run the
flutter devicescommand 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 theANDROID_HOME environment variable to that specific installation directory.
Atom editor
We recommend using Atom for editing, running, and debugging Flutter apps.
However, using our command-line tools, you can use any editor to develop Flutter applications.
To install Atom:
- Download Atom from the atom.io site.
- Extract the Atom executable from the downloaded file.
Configure Atom for Flutter development
Before creating your Flutter project in Atom, you’ll need to perform these pre-flight tasks:
- Launch the Atom editor.
Install the Flutter package by following these steps:
- From the menu, open Packages > Settings View > Install Packages/Themes.
- In the Install Packages field, type flutter and click the Packages button.
- You should see the Flutter package displayed. Click on the button to install the package.
Open Packages > Flutter > Package Settings, and set the FLUTTER_ROOT field to the
root directory where you installed the Flutter SDK.- Open Packages > Dart > Package Settings, and set the Dart SDK Location field to the
bin/cache/dart-sdkdirectory in your Flutter SDK’s root folder. - If you are using Atom on Mac, you should install the
atomandapmshell commands. To do
this from the menu bar, click onAtom>Install Shell Commands.
If you need help installing packages, consult the
Atom documentation or
email us.
Next steps
Now, follow our Getting Started guide
to run your first Flutter app on iOS and Android.