diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 227894536..1998c1dd3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,7 @@ # Contributing +_See also: [Flutter's code of conduct](https://flutter.io/design-principles/#code-of-conduct)_ + Want to contribute to the Flutter sample ecosystem? Great! First, read this page (including the small print at the end). diff --git a/INDEX.md b/INDEX.md new file mode 100644 index 000000000..d8b50ea24 --- /dev/null +++ b/INDEX.md @@ -0,0 +1,78 @@ +# A curated list of samples + +Contained in this list are sample apps, demos, and examples that can help you +grow your Flutter skills. Some are maintained here by the Flutter team, +but many have been created by the Flutter community and are kept in other repos +in and out of GitHub. + +This is not an exhaustive list of samples, and just because because a project +isn't listed here doesn't mean that it's not worth exploring. Similarly, while +the Flutter team works to keep this list up to date, there are plenty of others +created by the community, such as +[Awesome Flutter](https://github.com/Solido/awesome-flutter) from @Solido. + +## How-to Collections + +#### [Flutter Examples](https://github.com/nisrulz/flutter-examples) [![GitHub stars](https://img.shields.io/github/stars/nisrulz/flutter-examples.svg?style=social&label=Star)](https://github.com/nisrulz/flutter-examples) [![GitHub forks](https://img.shields.io/github/forks/nisrulz/flutter-examples.svg?style=social&label=Fork)](https://github.com/nisrulz/flutter-examples/fork) + +A collection of single-topic examples from Nishant Srivastava. These include +everything from gradients to JSON to routing and more. + +#### [Flutter Example Apps](https://github.com/iampawan/FlutterExampleApps) [![GitHub stars](https://img.shields.io/github/stars/iampawan/FlutterExampleApps.svg?style=social&label=Star)](https://github.com/iampawan/FlutterExampleApps) [![GitHub forks](https://img.shields.io/github/forks/iampawan/FlutterExampleApps.svg?style=social&label=Fork)](https://github.com/iampawan/FlutterExampleApps/fork) + +Several dozen examples from Flutter GDE Pawan Kumar. These cover state +management, Firebase, UI design, and many other topics. Each one comes with a +YouTube video showing implementation. + +#### [Flutter by Example](https://github.com/mjohnsullivan/flutter-by-example) [![GitHub stars](https://img.shields.io/github/stars/mjohnsullivan/flutter-by-example.svg?style=social&label=Star)](https://github.com/mjohnsullivan/flutter-by-example) [![GitHub forks](https://img.shields.io/github/forks/mjohnsullivan/flutter-by-example.svg?style=social&label=Fork)](https://github.com/mjohnsullivan/flutter-by-example/fork) + +Twenty-odd samples detailing common tasks with Flutter: how to use text fields, +streams and StreamBuilders, and more. + +## Architecture / networking / backend + +#### [Flutter Architectural Samples](https://github.com/brianegan/flutter_architecture_samples) [![GitHub stars](https://img.shields.io/github/stars/brianegan/flutter_architecture_samples.svg?style=social&label=Star)](https://github.com/brianegan/flutter_architecture_samples) [![GitHub forks](https://img.shields.io/github/forks/brianegan/flutter_architecture_samples.svg?style=social&label=Fork)](https://github.com/brianegan/flutter_architecture_samples/fork) + +Brian Egan's implementations of TodoMVC using a variety of state management and +architectural approaches. If you'd like to see how an app built with +`flutter-redux` is different from one using BLoC, this is a great place to +start. + +#### [jsonexample](jsonexample) _(Flutter team)_ + +A simple app showing three different approaches to deserializing JSON: +hand-written constructors, `json_serializable`, and `built_value`. + +## UI + +#### [Flutter UI Kit](https://github.com/iampawan/Flutter-UI-Kit) [![GitHub stars](https://img.shields.io/github/stars/iampawan/Flutter-UI-Kit.svg?style=social&label=Star)](https://github.com/iampawan/Flutter-UI-Kit) [![GitHub forks](https://img.shields.io/github/forks/iampawan/Flutter-UI-Kit.svg?style=social&label=Fork)](https://github.com/iampawan/Flutter-UI-Kit/fork) +Another sample from Flutter GDE Pawan Kumar, this repo includes a variety of +polished UI examples. + + +#### [Flutter Challenges](https://github.com/matthew-carroll?tab=repositories&q=flutter_ui_challenge) +More a GitHub search result than a single repo, Matt Carroll's Flutter UI +challenges showcase some amazing designs powered by Flutter. Make sure to check +the accompanying YouTube video so you can watch Matt implement them. + +## Full apps + +#### [inKino](https://github.com/roughike/inKino) [![GitHub stars](https://img.shields.io/github/stars/roughike/inKino.svg?style=social&label=Star)](https://github.com/roughike/inKino) [![GitHub forks](https://img.shields.io/github/forks/roughike/inKino.svg?style=social&label=Fork)](https://github.com/roughike/inKino/fork) +An unofficial Finnkino client that shows movie details and showtimes for movies +in Finland. It's currently available in both the +[App Store](https://itunes.apple.com/gb/app/inkino/id1367181450?mt=8) and +[Play Store](https://play.google.com/store/apps/details?id=com.roughike.inkino). + +#### [FlutterFlip](https://github.com/redbrogdon/flutterflip) [![GitHub stars](https://img.shields.io/github/stars/redbrogdon/flutterflip.svg?style=social&label=Star)](https://github.com/redbrogdon/flutterflip) [![GitHub forks](https://img.shields.io/github/forks/redbrogdon/flutterflip.svg?style=social&label=Fork)](https://github.com/redbrogdon/flutterflip/fork) +A simple reversi clone built with Flutter. It showcases some implicit animations +and how to move work off the UI thread into an isolate. + +## Demos + +#### [Shrine](shrine) _(Flutter team)_ +The Shrine demo app from the Flutter team. It's designed to showcase how apps +can put their own spin on the Material Design components and how to use +ScopedModel to maintain app state across screens. + +#### [Flutter Gallery](https://github.com/flutter/flutter/tree/master/examples/flutter_gallery) _(Flutter team)_ +The official Flutter Gallery. There's tons of stuff in here. Just tons. diff --git a/README.md b/README.md index 98379ca65..0c5e2eeeb 100644 --- a/README.md +++ b/README.md @@ -9,10 +9,12 @@ This repo will be getting significantly larger as Flutter progresses toward 1.0. ## Index -### [`jsonexample`](jsonexample) +For a curated list of samples in this repo and elsewhere, see the +[index](INDEX.md). -A simple app that deserializes a set of JSON strings using three -different libraries: `dart:convert`, `json_serializable`, and `built_value`. +## Interested in contributing? + +See the [contributor's guide](CONTRIBUTING.md)! ## Questions or issues?