| Adam Barth | a74d02d | 2015-09-26 12:37:27 -0700 | [diff] [blame] | 1 | Flutter Examples |
| 2 | ================ |
| Collin Jackson | 633b650 | 2015-07-16 11:54:25 -0700 | [diff] [blame] | 3 | |
| Michael Thomsen | 2c063b7 | 2018-10-08 08:45:24 +0200 | [diff] [blame] | 4 | This directory contains several examples of using Flutter. To run an example, |
| 5 | use `flutter run` inside that example's directory. See the [getting started |
| Tim Sneath | 5291897 | 2019-04-05 11:39:30 -0700 | [diff] [blame] | 6 | guide](https://flutter.dev/getting-started/) to install the `flutter` tool. |
| Collin Jackson | 633b650 | 2015-07-16 11:54:25 -0700 | [diff] [blame] | 7 | |
| Michael Thomsen | 2c063b7 | 2018-10-08 08:45:24 +0200 | [diff] [blame] | 8 | For additional samples, see the |
| 9 | [`flutter/samples`](https://github.com/flutter/samples) repo. |
| qchong | 517ddab | 2016-09-27 14:39:15 -0700 | [diff] [blame] | 10 | |
| Jim Beveridge | 93fa446 | 2015-10-13 13:53:05 -0700 | [diff] [blame] | 11 | Available examples include: |
| 12 | |
| Michael Thomsen | 2c063b7 | 2018-10-08 08:45:24 +0200 | [diff] [blame] | 13 | - **Hello, world** The [hello world app](hello_world) is a minimal Flutter app |
| 14 | that shows the text "hello, world." |
| Collin Jackson | 633b650 | 2015-07-16 11:54:25 -0700 | [diff] [blame] | 15 | |
| Hans Muller | 74c3e74 | 2016-05-09 11:00:54 -0700 | [diff] [blame] | 16 | - **Flutter gallery** The [flutter gallery app](flutter_gallery) showcases |
| Michael Thomsen | 2c063b7 | 2018-10-08 08:45:24 +0200 | [diff] [blame] | 17 | Flutter's widgets, including its implementation of [material |
| MhdHejazi | af3cdb3 | 2019-02-01 21:14:48 +0300 | [diff] [blame] | 18 | design](https://material.io/design/). |
| Sarah Zakarias | 3c99272 | 2017-03-24 11:51:54 +0100 | [diff] [blame] | 19 | |
| Adam Barth | 140bf64 | 2016-04-20 10:58:06 -0700 | [diff] [blame] | 20 | - **Layers** The [layers vignettes](layers) show how to use the various layers |
| Michael Thomsen | 2c063b7 | 2018-10-08 08:45:24 +0200 | [diff] [blame] | 21 | in the Flutter framework. For details, see the [layers |
| 22 | README](layers/README.md). |
| Ian Hickson | a52c7b4 | 2017-04-05 11:28:33 -0700 | [diff] [blame] | 23 | |
| Michael Thomsen | 2c063b7 | 2018-10-08 08:45:24 +0200 | [diff] [blame] | 24 | - **Platform Channel** The [platform channel app](platform_channel) demonstrates |
| 25 | how to connect a Flutter app to platform-specific APIs. For documentation, see |
| Tim Sneath | 5291897 | 2019-04-05 11:39:30 -0700 | [diff] [blame] | 26 | <https://flutter.dev/platform-channels/>. |
| Michael Thomsen | 2c063b7 | 2018-10-08 08:45:24 +0200 | [diff] [blame] | 27 | |
| 28 | - **Platform Channel Swift** The [platform channel swift |
| 29 | app](platform_channel_swift) is the same as [platform |
| 30 | channel](platform_channel) but the iOS version is in Swift and there is no |
| 31 | Android version. |
| 32 | |
| 33 | ## Notes |
| Mikkel Nygaard Ravn | 1731a16 | 2017-06-29 09:48:01 +0200 | [diff] [blame] | 34 | |
| 35 | Note on Gradle wrapper files in `.gitignore`: |
| 36 | |
| Michael Thomsen | 2c063b7 | 2018-10-08 08:45:24 +0200 | [diff] [blame] | 37 | Gradle wrapper files should normally be checked into source control. The example |
| 38 | projects don't do that to avoid having several copies of the wrapper binary in |
| 39 | the Flutter repo. Instead, the Gradle wrapper is injected by Flutter tooling, |
| 40 | and the wrapper files are .gitignore'd to avoid making the Flutter repository |
| 41 | dirty as a side effect of running the examples. |
