Widgetbook

Widgetbook Hosting

The Widgetbook Hosting allows users to upload the Flutter web version of a Widgetbook to Widgetbook Cloud. To upload any Widgetbook, you require an API key.

How to create an API key#

To create an API key, you need to login with your account on Widgetbook Cloud. API keys are bound to projects. Therefore, you require a project to retrieve an API key.

Only users users with the Owner role can fetch the API key of a project.

If you are not the owner of your project but would still like to fetch the API key, please ask your project owner to promote you from member to owner. For information on member management, please see member management.

On the detail page of a project, a card which allows to fetch the API key is displayed. Click the button on the card to fetch the API key.

The API key will be copied to your clipboard.

Hosting with CI/CD vendors#

If youd like to upload a Widgetbook Build and create Reviews your CI/CD pipeline requires the following:

  1. Install Flutter SDK
  2. Run the build_runner package via flutter pub run build_runner build --delete-conflicting-outputs
  3. Build your Widgetbook via flutter build web -t path/to/widgetbook/main/file
  4. Activate the Widgetbook CLI via dart pub global activate widgetbook_cli 3.0.0-beta.22
  5. Run the CLI as described in the docs

Examples#

CI/CD VendorLink
GitHub🔗
GitHub with Codemagic🔗
Azure🔗
GitLab🔗

Are we missing your CI/CD vendor? Let us know via Discord, we'd love to help you.