Skip to content

Commit 247fc10

Browse files
Merge pull request #1033 from Shopify/update-non-embedded-instructions
Add some missing steps to the non-embedded instructions
2 parents 9672ef8 + bb38e4a commit 247fc10

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ export default defineConfig({
171171
});
172172
```
173173

174-
## Gotchas / Troubleshooting
174+
## Troubleshooting
175175

176176
### Database tables don't exist
177177

@@ -195,11 +195,13 @@ This only applies if your app is embedded, which it will be by default.
195195

196196
### Non Embedded
197197

198-
Shopify apps are best when they are embedded into the Shopify Admin. This template is configured that way. If you have a reason to not embed your please make 2 changes:
198+
Shopify apps are best when they are embedded in the Shopify Admin, which is how this template is configured. If you have a reason to not embed your app please make the following changes:
199199

200-
1. Change the `isEmbeddedApp` prop to false for the `AppProvider` in `/app/routes/app.jsx`
201-
2. Remove any use of App Bridge APIs (`window.shopify`) from your code
202-
3. Update the config for shopifyApp in `app/shopify.server.js`. Pass `isEmbeddedApp: false`
200+
1. Ensure `embedded = false` is set in [shopify.app.toml`](./shopify.app.toml). [Docs here](https://shopify.dev/docs/apps/build/cli-for-apps/app-configuration#global).
201+
2. Pass `isEmbeddedApp: false` to `shopifyApp()` in `./app/shopify.server.js|ts`.
202+
3. Change the `isEmbeddedApp` prop to `isEmbeddedApp={false}` for the `AppProvider` in `/app/routes/app.jsx|tsx`.
203+
4. Remove the `@shopify/app-bridge-react` dependency from [package.json](./package.json) and `vite.config.ts|js`.
204+
5. Remove anything imported from `@shopify/app-bridge-react`. For example: `NavMenu`, `TitleBar` and `useAppBridge`.
203205

204206
### OAuth goes into a loop when I change my app's scopes
205207

0 commit comments

Comments
 (0)