Skip to content

Quickstart

This quickstart uses the demo app included in the trainingkit_flutter repository to validate the full workout launch flow without building a new app from scratch.

1. Clone the repository

sh
git clone https://github.com/getfizzup/trainingkit-flutter
cd trainingkit-flutter/example

2. Install Flutter dependencies

sh
flutter pub get

3. Configure Android credentials

Create example/android/local.properties with your GitHub credentials:

properties
GithubUser=your-github-username
GithubToken=your-github-token

4. Run the demo app

macOS only

Running the iOS flow requires a Mac with Xcode and Flutter's Swift Package Manager enabled (the default on Flutter 3.29+). The first iOS build resolves the TrainingKit Swift package from GitHub, so it needs network access. To try only the Android flow, run flutter run -d android.

Pick a target device — flutter run -d ios does not work, because ios is a platform, not a device id. List devices with flutter devices, then run on one of them:

sh
# Android emulator or device
flutter run -d android

# iOS: boot a simulator first, then run on it
open -a Simulator
flutter run

The demo app connects to the FizzUp demo GraphQL endpoint. It lists available workouts and launches the native workout experience when a workout is selected.

Next steps

  • Installation: Integrate the package into an existing Flutter app.
  • Usage: Wire a GraphQL client, list workouts, and launch a session in your own app.
  • Authentication: Understand the device identifier and token flow.