Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions docs/integrations/github/_category_.json

This file was deleted.

Binary file removed docs/integrations/github/ff_github_private.gif
Binary file not shown.
99 changes: 0 additions & 99 deletions docs/integrations/github/getting-started.md

This file was deleted.

Binary file removed docs/integrations/github/imgs/img.png
Binary file not shown.
Binary file removed docs/integrations/github/imgs/img_1.png
Binary file not shown.
Binary file removed docs/integrations/github/imgs/img_3.png
Binary file not shown.
Binary file removed docs/integrations/github/imgs/img_4.png
Binary file not shown.
Binary file removed docs/integrations/github/imgs/img_5.png
Binary file not shown.
Binary file removed docs/integrations/github/imgs/img_6.png
Binary file not shown.
Binary file removed docs/integrations/github/imgs/img_7.png
Binary file not shown.
Binary file removed docs/integrations/github/imgs/img_8.png
Binary file not shown.
Binary file removed docs/integrations/github/imgs/img_9.png
Binary file not shown.
4 changes: 2 additions & 2 deletions docs/intro/ff-ui/toolbar.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,8 +148,8 @@ You can make a project public so that others can view and clone your project. Be

## Preview

You can use this option to run your app in [Preview mode](../../resources/Projects/how-to-run-test-projects#preview-mode).
You can use this option to run your app in [Preview mode](../../testing-deployment-publishing/running-your-app/run-your-app#preview-mode).

## Testing

This menu allows you to run your app in [Test](../../resources/Projects/how-to-run-test-projects#test-mode) or [Run](../../resources/Projects/how-to-run-test-projects#run-mode) mode.
This menu allows you to run your app in [Test](../../testing-deployment-publishing/running-your-app/run-your-app#test-mode) or [Run](../../testing-deployment-publishing/running-your-app/run-your-app#run-mode) mode.
143 changes: 4 additions & 139 deletions docs/resources/Projects/how-to-run-test-projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,142 +9,7 @@ sidebar_position: 3

There are 4 ways to test your project in FlutterFlow.

- Preview
- Test
- Run
- Local Run

## Preview Mode

You can use the Preview Mode to quickly try out your app on a virtual device
without waiting for it to build. This is helpful primarily for navigation and
animations. You can also preview your app in the Dark/Light mode and visualize
it on various mobile, tablet, and desktop devices.

### When to Use Preview Mode

The primary benefit of "Preview Mode" is that it allows your app to load
instantly, making it ideal for UI testing. However, most business logic is not
included in this mode. As a result, "Preview Mode" is used less frequently than
other testing modes, which provide a more comprehensive evaluation of the app's
functionality.

:::caution[Preview Mode Limitations]

- Actions may not trigger or work properly.
- FontAwesome icons jump around when mouse hovers over certain material widgets.
- Firestore data is not loaded from Firebase.
- Firebase auth flow can't be tested. We always allow log in.
- API Calls can't be run or tested here.
- Refresh if animation actions are not working.
- Refresh if Clear TextFields actions are not working
- RevenueCat data is not loaded.
- Paywall actions execute as if the entitlement is active.
- Hero Animation may not work on dynamically generated widgets.
- Dropdown disabling does not work in
- Preview Mode.
- Tooltip does not work for some screen sizes in Preview Mode.
:::

## Test Mode

_Test Mode_ runs a web version of your Flutter app and uses Flutter's "Hot
Reload" feature, which lets you immediately see any changes made to code in an
emulator or on-device. Running your app in _Test Mode_ helps you experiment,
test UIs, and fix bugs faster.

To run your app in Test Mode:

1. Click on the **Test icon** or press **Cmd/Ctrl + I** (a keyboard shortcut).
This will run your app in a new browser window.
2. Switch to the app builder and make some changes, such as changing colors and
alignment.
3. Now switch to the Test Mode tab and click **Instant Reload** or press *
*Cmd/Ctrl + J** to see the changes in under 10 seconds.

#### Test Mode Button Colors

The test mode button color indicates the following status:

- Orange: Building
- Green: Ready
- Yellow: Expiring Soon
- Red: Expired

### When to Use Test Mode

When designing and developing your app, Test Mode is the second most common
testing mode (next to Local Run).
Its [Hot Reloading](https://docs.flutter.dev/tools/hot-reload) allows for fast
iteration and testing. Its downsides compared to Local Run are its restricted
time (30 min.) and lack of access to some features (e.g. camera).

:::warning[Troubleshooting – Slow Loading]
If you see a progress bar at the top of the device running for over 15 seconds,
try refreshing the page.
:::

:::caution[Test Mode Limitations]
**Test Mode** has certain limitations because some packages are not supported on
the web and because of the way FlutterFlow configures your project to run in the
cloud.

- 30 minute testing time. After the 30 minutes has expired, you can start
another test mode session.
- If you see a grey "broken" screen with a sad face, it may be a DNS server
issue with your network provider. We recommend using CloudFlare's 1.1.1.1 DNS
server. Click here to see instructions.
- Lottie animation may not load if you provide a variable path.
- Cookies need to be enabled for Test Mode to function properly. They are only
used for functional purposes.
- If you see a progress bar where the phone outline should be that lasts longer
than a 15 seconds, try refreshing the page.
- The device screen can not be wider than the page's width.
- Copy to Clipboard Action is not supported in Test Mode.
Use [Run Mode](#run-mode) to avoid this issue.
- Widgets having Shimmer or Tint animation might not appear properly.
- Assets used within Custom Code might not appear properly.
- Audio Recording actions do not work in Test Mode, use web publishing in
Settings to test recording audio or test it on emulator via Local Run.
:::

## Run Mode

You can test a fully functional version of your app using the _Run_ mode,
including live data. It will build the app, which typically requires around 2-4
minutes - but can be longer for larger projects. You can then interact with your
app through your web browser. This is a web version of the app, identical to the
version that is run on _Test Mode_.

To run the app in Run Mode:

1. Click on the **dropdown** next to the Test Mode button or press
**Cmd/Ctrl + E** (keyboard shortcut). This will run your app in a new
browser window.

### When to Use Run Mode

The main benefit of Run Mode is the ability to share a running app. The link to
this Run Mode session is public and shareable. All Run Mode sessions will persist and
can be
accessed in the drop down menu next to the lightning bolt icon in upper right of
the FlutterFlow builder.

:::caution[Run Mode Limitations]
Run Mode does not support Hot Reloading so any changes you make to your app will
not be reflected in the Run Mode. In order to see the changes you would have to
create another Run Mode.
:::

## Local Run

You can test your app on an emulator or physical mobile device with Local Run
feature, which is available in the FlutterFlow Desktop App. Local Run downloads
the code locally and gives you the option to use [Flutter's Hot Reload](https://docs.flutter.dev/tools/hot-reload) or Hot
Restart to see your changes instantly on a device.

:::info
Please note that Local Run is currently available only on the [Paid Plans](https://flutterflow.io/pricing)
:::

[How to Setup Local Run](https://docs.flutterflow.io)
- **[Preview](../../testing-deployment-publishing/running-your-app/run-your-app#preview-mode)**: This mode allows for quick testing of the user interface on a virtual device without requiring a full build.
- **[Test](../../testing-deployment-publishing/running-your-app/run-your-app#test-mode)**: This mode runs a web version of your app with Flutter's "Hot Reload" feature, enabling you to visualize changes immediately.
- **[Run](../../testing-deployment-publishing/running-your-app/run-your-app#run-mode)**: This mode allows for testing a fully functional version of your app with live data.
- **[Local Run](../../testing-deployment-publishing/running-your-app/local-run)**: This feature, available in the FlutterFlow Desktop App, lets you test your app on an emulator or physical mobile device.
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Branching & Collaboration",
"position": 1
}
Loading