ZapbirdDocs

Quick start

Go from nothing to your Flutter app running on your phone.

#Install Flutter

Zapbird is built for Flutter 3.41.x (Dart 3.11). Install Flutter from flutter.dev, then check it:

Terminal
$ flutter --version$ flutter doctor

#Install the command

Run the installer for your computer. It puts zapbird on your PATH and then downloads the runner SDK for this computer, so there is nothing more to install.

In Terminal:

Terminal
$ curl -fsSL https://pub-8e7a72f4641f4f3691a843f412d19af4.r2.dev/cli/install.sh | sh

With Homebrew on an Apple silicon Mac you can install the command instead, and then get the SDK yourself:

Terminal
$ brew install Jago-Intelligence/zapbird/zapbird$ zapbird sdk install

Check that it is installed:

Terminal
$ zapbird --version

#Check the runner SDK

The installer already installed the SDK. See what you have:

Terminal
$ zapbird sdk list

If the installer could not download it, or you used Homebrew, install it with one command. When the runner on your phone updates, get the new SDK the same way:

Terminal
$ zapbird sdk install$ zapbird sdk upgrade

#Create a project

This runs flutter create and writes a zapbird.yaml beside the app.

Terminal
$ zapbird create my_app$ cd my_app

#Check your setup

Doctor checks the network address, the project, Flutter, the SDK and your packages. Each line says what is wrong and how to fix it.

Terminal
$ zapbird doctor

#Start the server

Start compiles your app and prints a QR code. Keep it running while you work.

Terminal
$ zapbird start

#Scan and approve

Open Zapbird on your phone, scan the QR code, and approve the project. In the runner Settings, turn on Trusted Flutter apps to run a full app.

#Edit and save

Change lib/main.dart and save. The phone updates by itself. If something fails, the error shows on the phone and the log shows in your terminal.

Was this doc helpful?

Zapbird sends no analytics. Read about security.

Flutter and the related logo are trademarks of Google LLC. Zapbird is not endorsed by or affiliated with Google LLC.

esc