Skip to content

Latest commit

 

History

History
131 lines (100 loc) · 4.59 KB

README.md

File metadata and controls

131 lines (100 loc) · 4.59 KB
Raw

Flutter Gallery

Flutter Gallery is a resource to help developers evaluate and use Flutter. It is a collection of Material Design & Cupertino widgets, behaviors, and vignettes implemented with Flutter. We often get asked how one can see Flutter in action, and this gallery demonstrates what Flutter provides and how it behaves in the wild.

Flutter Gallery

Running Flutter Gallery on Flutter's master channel

The Flutter Gallery targets Flutter's master channel. As such, it can take advantage of new SDK features that haven't landed in the stable channel.

If you'd like to run the Flutter Gallery, make sure to switch to the master channel first:

flutter channel master
flutter upgrade

When you're done, use this command to return to the safety of the stable channel:

flutter channel stable
flutter upgrade

Supported Platforms

Flutter Gallery has been built to support multiple platforms. This includes:

  • Android
  • iOS
  • web
  • macOS
  • Linux
  • Windows

An APK, macOS, Linux, and Windows builds are available for download. You can find it on the web at gallery.flutter.dev and on the Google Play Store.

You can build from source yourself for any of these platforms, though, please note desktop support must be enabled. For example, to run the app on Windows:

cd gallery/
flutter config --enable-windows-desktop
flutter create .
flutter run -d windows

Additionally, the UI adapts between mobile and desktop layouts regardless of the platform it runs on. This is determined based on window size as outlined in adaptive.dart.

To include a new splash animation

  1. Convert your animation to a .gif file. Ideally, use a background color of 0xFF030303 to ensure the animation blends into the background of the app.

  2. Add your new .gif file to the assets directory under assets/splash_effects. Ensure the name follows the format splash_effect_$num.gif. The number should be the next number after the current largest number in the repository.

  3. Update the map _effectDurations in splash.dart to include the number of the new .gif as well as its estimated duration. The duration is used to determine how long to display the splash animation at launch.

Generating localizations

If this is the first time building the Flutter gallery, the localized code will not be present in the project directory. However, after running the application for the first time, a synthetic package will be generated containing the app's localizations through importing package:flutter_gen/gen_l10n/.

See separate README for more details.

Generating highlighted code segments

To generate highlighted code segments, make sure that you have grinder installed by running

flutter pub get

To generate code segments (see separate README for more details):

flutter pub run grinder update-code-segments

Creating a new release (for Flutter org members)

  1. Bump the version number up in the pubspec.yaml. Use semantic versioning to determine which number to increment. For example 2.2.0+020200 should become 2.3.0+020300.

  2. Create tag on master branch after the version is bumped. This will start a Github Actions job that will create a release draft with desktop applications and apk included.

    git pull upstream master
git tag v2.3
git push upstream v2.3

  3. Publish the firebase hosted web release.

    • Log in to the account that has write access to gallery-flutter-dev with firebase login
    • flutter pub run grinder build-web
    • firebase deploy -P prod to deploy to production (equivalent to firebase deploy).
    • firebase deploy -P staging to deploy to staging. Check with the team to see if the staging instance is currently used for a special purpose.

  4. Publish the Android release

    • Ensure you have the correct signing certificates.
    • Create the app bundle with flutter build appbundle.
    • Upload to the Play store console.
    • Publish the Play store release.

  5. Go to Releases and see the latest draft.

    • Update the description to include what changes have been done since the last release.
    • Publish the release.