Skip to content

Commit 6523fa9

Browse files
authored
Merge pull request #30 from FlutterFlow/test--on-mobile
addnig docs for testing on mobile
2 parents 84c9ea0 + c562393 commit 6523fa9

File tree

2 files changed

+79
-6
lines changed

2 files changed

+79
-6
lines changed
88.3 KB
Loading

docs/test-and-publish/test/test-on-mobile-device.md

Lines changed: 79 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,86 @@ keywords: [Dreamflow, Test, Mobile Device, Android, iOS]
88
---
99

1010
# Testing App on Mobile Devices
11-
Testing your app on mobile devices is essential to ensure it performs as expected in real-world scenarios. You can do this by downloading the code and running it locally on your machine.
11+
Testing your app on real phones and tablets helps you make sure it looks and behaves exactly as your users will experience it. Dreamflow offers two main ways to test:
12+
13+
1. **Live Preview on Your Mobile Device**
14+
- Great for quickly trying out changes as you build in Dreamflow.
15+
- Instantly updates as you make edits.
16+
- Runs in your mobile browser, so it won’t test device-specific features like push notifications, camera access, location services, or in-app purchases.
17+
18+
2. **Download and Run the App on Your Device**
19+
- Best for testing how your app behaves as a real iOS or Android app.
20+
- Lets you verify that features tied to the device’s operating system—such as notifications, camera, file storage, or app permissions—work properly.
21+
- Requires some setup; you’ll need to download, build, and install the app each time you want to test new changes.
1222

1323
:::info[Prerequisites]
1424
Downloading the code is only available with a [**paid subscription**](https://dreamflow.app/pricing).
1525
:::
1626

17-
## Android Setup
27+
## Using the Live Preview on Your Mobile Device
28+
29+
In Dreamflow you can use the device icon button in the bottom right corner of the canvas to pull up a QR code for accessing the preview on your mobile device.
30+
31+
![device_icon.png](imgs/device_icon.png)
32+
33+
When you scan the QR code or open the preview link on your phone, here’s what to keep in mind:
34+
35+
- **For testing only**: The mobile preview is meant for testing your app as you build. It’s not intended for sharing with others or hosting your live app.
36+
- **Real-time updates**: Any change you make in Dreamflow will instantly appear in the mobile preview, just like in the builder preview.
37+
- **Persistent link**: The QR code and preview link stay the same for your project, so you can reuse them. However, the preview will only load when your project is open and running in Dreamflow.
38+
- **Session limit**: You can have up to 5 preview sessions open at once. Each open browser tab or connected device counts as one session.
39+
- **Preview controlled through Dreamflow Project**: You must have your project open and running Dreamflow to use the mobile preview. If you close your Dreamflow project, the preview will stop working until you reopen it. The preview controls like hot reload, hot restart and stop also control the preview on your mobile device.
40+
- **Browser-based**: The preview runs in your mobile browser. It’s great for checking layout, user interactions and functionality but won’t test features that rely on the actual app installation (like push notifications, camera access, or offline storage).
41+
42+
:::warning[reminder]
43+
44+
You must have your project open and running Dreamflow to use the mobile preview.
45+
46+
:::
47+
48+
### Installing the Preview as a PWA
49+
50+
You can also install your app on your phone or tablet as a Progressive Web App (PWA). This lets you open it directly from your home screen—just like a regular mobile app.
51+
52+
#### Why install as a PWA?
53+
54+
Installing as a PWA is helpful when you want to:
55+
56+
- **Experience your app like a real mobile app**: It opens in full-screen mode without the browser interface (no address bar or tabs).
57+
58+
- **Quickly access your app**: You can launch it with a single tap from your home screen. Note that your project will need to be open and running in Dreamflow for the PWA to load. The quick access still allows you to rapdily pull up the preview without needing to scan the QR code again.
59+
60+
61+
:::note
62+
A PWA still runs in your browser under the hood, so it won’t support native device features like push notifications, camera, or local file access. To test those, you’ll need to run the actual iOS or Android build as mentioned below.
63+
:::
64+
65+
#### How to install PWA
66+
67+
**On iOS**
68+
69+
1. Open the preview link or scan the QR code in **Safari**
70+
2. Tap the Share icon (the square with an arrow).
71+
3. Select Add to Home Screen.
72+
4. Optionally modify the name for your app and tap **Add**.
73+
5. The app will appear on your home screen and open in full screen when tapped.
74+
75+
:::note
76+
Other browsers on iOS (like Chrome or Edge) may work, but for the most reliable experience use Safari.
77+
:::
78+
79+
**On Android**
80+
81+
1. Open the preview link or scan the QR code using your mobile browser.
82+
2. When prompted, tap **Install App** or **Add to Home Screen**.
83+
- If you don’t see a prompt, open the browser menu (⋮) and select **Add to Home Screen.**
84+
4. Optionally modify the name for your app and confirm.
85+
5. The app will appear on your home screen and can be opened like any other app.
86+
87+
88+
## Testing Natively on your Device
89+
90+
### Android Setup
1891

1992
To test your app on an Android device or emulator, you first need to set up your development environment, install Flutter, and configure your target device. Instructions for each platform are available here: [**Windows**](https://docs.flutter.dev/get-started/install/windows/mobile), [**Mac**](https://docs.flutter.dev/get-started/install/macos/mobile-android), [**Linux**](https://docs.flutter.dev/get-started/install/linux/android).
2093

@@ -28,7 +101,7 @@ For more detailed guidance, refer to the [**Android Flutter documentation**](ht
28101

29102
:::
30103

31-
## iOS Setup
104+
### iOS Setup
32105

33106
For app testing on an iOS device or simulator, you need a Mac with Xcode installed. Follow [**these instructions**](https://docs.flutter.dev/get-started/install/macos/mobile-ios) to set up your Mac.
34107

@@ -44,7 +117,7 @@ For more detailed guidance, refer to the [**iOS Flutter documentation**](https:
44117

45118
:::
46119

47-
## Download Code and Run
120+
### Download Code and Run
48121

49122
To download your app code, click on your project name and select the **Download Code** option.
50123

@@ -65,7 +138,7 @@ Once downloaded, open the project in your preferred IDE and run your app on eith
65138
If you encounter a version compatibility issue with Flutter, you can resolve it by upgrading to the latest version. Simply execute the `flutter upgrade` command in your terminal. To verify your current Flutter version, use the `flutter --version` command.
66139
:::
67140

68-
## Building APK File
141+
### Building APK File
69142

70143
You can build APK files locally to test your app on Android devices or prepare it for release on the Google Play Store.
71144

@@ -114,7 +187,7 @@ You can follow the official Flutter documentation for detailed steps:
114187
- [Sign the app](https://docs.flutter.dev/deployment/android#sign-the-app)
115188
- [Build the app for release](https://docs.flutter.dev/deployment/android#build-the-app-for-release)
116189

117-
## Building IPA File
190+
### Building IPA File
118191

119192
You can’t generate a debug `.ipa` file. Debug builds are only for local development and testing, and once your [iOS setup](#ios-setup) is complete, you can [run](#download-code-and-run) them directly on your device.
120193

0 commit comments

Comments
 (0)