Skip to content

GETTING_STARTED.md

Latest commit

 

History

History
68 lines (47 loc) · 1.53 KB

GETTING_STARTED.md

File metadata and controls

68 lines (47 loc) · 1.53 KB
Raw

Getting Started

Prerequisites

Install Flutter. See the official setup guide.

You also need an editor. See the Flutter docs for setup.

Run an example app

Clone this repository and install packages:

git clone https://github.com/nisrulz/flutter-examples.git
cd flutter-examples
make packages

Open any example folder in your editor, then run the app on a device or emulator:

cd <example-folder>
flutter run

For example:

cd simple_material_app
flutter run

Where to look for the example code

Every example app is split into two files:

  • lib/main.dart: the app wrapper. It only sets up the MaterialApp (title, theme, routes).
  • lib/example.dart: the focused example code. This file teaches the concept the app demonstrates. Open it to see how the feature works.

Useful links

Download a single example

The repository is large. If you only want one example, use git sparse-checkout:

git clone --no-checkout https://github.com/nisrulz/flutter-examples.git
cd flutter-examples
git sparse-checkout init --cone
git sparse-checkout set <example_folder>
git checkout

Example:

git clone --no-checkout https://github.com/nisrulz/flutter-examples.git
cd flutter-examples
git sparse-checkout init --cone
git sparse-checkout set simple_material_app
git checkout

You now have the single example checked out.