Code Push Quickstart
This guide shows you the fastest way to install Shorebird and try code push.
This document is a (slightly) condensed version of our code push docs, all on one page.
Before you can create a Shorebird app, you will need to sign up for Shorebird.
To create an account, head over to the Shorebird Console and authenticate with one of the available authentication methods.
Once you have logged into the console, follow the instructions to install the Shorebird CLI on your machine.
Once you have registered and installed the CLI, you’re ready to use code push!
Start by creating a new Flutter app:
As with any Flutter app, you can verify this created the standard Counter app by
following the instructions printed by flutter create
:
To make this a Shorebird app, run:
This will create a shorebird.yaml
file in the root of your project. This file
contains your Shorebird app_id
.
This will also run shorebird doctor
to ensure everything is set up correctly.
Shorebird expects to find the latest stable flutter
installed on your
machine. Shorebird can be configured to work with older versions of Flutter
(back to 3.10.0). See Flutter Version Management for more
info.
We will create a release using the unmodified Counter app. Run:
When prompted, use the suggested version number (1.0.0+1
), and enter y
when
asked if you would like to continue.
To preview the release with Shorebird (that is, with Shorebird’s fork of the Flutter engine), run:
Now kill the app on your device or emulator.
We will now make a small change to the Counter app. In lib/main.dart
, change
the app theme’s primarySwatch
from blue to green:
After making this change, save the file and run:
Launch the app from your device or emulator. The app will still have the original blue theme, but it will be downloading the patch we just created in the background. Kill and launch the app again, and the app will be green! 🎉