Skip to content

Commit cd3b84b

Browse files
authored
add guide for testing mini apps (#668)
* add guide for testing mini app * fix spelling * remove Steps component and add a callout for basedev console * add steps to DM section
1 parent 3ccd4b9 commit cd3b84b

File tree

2 files changed

+79
-1
lines changed

2 files changed

+79
-1
lines changed

docs/docs.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -496,7 +496,8 @@
496496
"pages": [
497497
"mini-apps/troubleshooting/common-issues",
498498
"mini-apps/troubleshooting/base-app-compatibility",
499-
"mini-apps/troubleshooting/how-search-works"
499+
"mini-apps/troubleshooting/how-search-works",
500+
"mini-apps/troubleshooting/testing"
500501
]
501502
},
502503
{
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
title: Test Your App
3+
description: Confidently test your app before going live in the Base app
4+
---
5+
6+
Testing your mini app before launch ensures it functions correctly, displays properly, and provides the user experience you intended. You can test your app using a few different methods, each suited for different stages of development and testing needs. The only requirement is to have your mini app publicly accessible URL via `https://`.
7+
8+
## Base Build Preview Tool
9+
10+
Preview and debug your mini app to ensure it displays correctly in the Base App using the [Preview Tool.](https://www.base.dev/preview)
11+
12+
<Info>
13+
Your browser's console won't show Base-specific logs. Base.dev console provides logs specific to how your mini app works within the Base app, including user context and Base app-specific functionality.
14+
</Info>
15+
16+
### Best for
17+
18+
* Validating correctness of manifest files and required fields
19+
* Using an interactive console for viewing logs
20+
* Signing your app's manifest
21+
22+
### Not ideal for testing
23+
* Full look and feel on your app in Base app
24+
* Chat and Base app specific functionality
25+
* User context functionality
26+
27+
### Steps
28+
29+
1. Navigate to [Base.dev/preview](https://www.base.dev/preview)
30+
2. Log in using your Base app account
31+
3. Paste your app's url in the field
32+
4. Click `Submit`
33+
34+
## Base app
35+
36+
Preview how your app would function directly using the Base App.
37+
38+
### Best for
39+
40+
* Keeping your app private from the feed
41+
* Preview in-app functionality (UX)
42+
* Chat-based applications
43+
* Apps that require user and Base app context
44+
45+
### Not ideal for testing
46+
47+
* Logs
48+
* Validating correctness of manifest file
49+
50+
### Steps
51+
52+
1. Enable Developer Mode: **Open Base App > Privacy & Security > toggle Developer Mode**
53+
2. Open preview: **Settings > Developer > Preview**
54+
3. Enter the URL of your mini app
55+
4. Click `Preview`
56+
57+
## In-feed and DMs
58+
59+
Preview your app by posting the URL directly in the Base app feed or by sending a DM to another user.
60+
61+
### Best for
62+
63+
* Requesting feedback from the public
64+
* Apps that require user and Base app context
65+
* Testing edge cases
66+
67+
### Not ideal for
68+
69+
* Viewing logs
70+
* Validating correctness of manifest file
71+
72+
### Steps
73+
74+
1. Open [Base app](https://join.base.app/)
75+
2. Share your mini app URL by:
76+
- Posting it in the Base app feed, or
77+
- Sending it in a DM to someone or a group chat

0 commit comments

Comments
 (0)