How-to guides
These guides assume you already have an OpenShop project. If you are starting
from an empty directory, follow the first-app tutorial.
Run app commands from the directory containing openshop.config.ts.
Build an integration
Section titled “Build an integration”| I want to… | Guide |
|---|---|
| Configure one or several Shopify apps | Configure Shopify apps |
| Save credentials and call an external API | Connect an external service |
| Send Shopify orders to a provider on a schedule | Sync orders with a flow |
| Respond to Shopify events | Handle a Shopify webhook |
Extend the app
Section titled “Extend the app”| I want to… | Guide |
|---|---|
| Serve a storefront or Customer Account extension | Add proxy routes |
| Expose an endpoint to another service | Add a server route |
| Add a screen inside Shopify admin | Add a custom admin page |
| Verify behavior before shipping | Test an app |
Deploy and operate
Section titled “Deploy and operate”| I want to… | Guide |
|---|---|
| Change the database schema | Manage migrations |
| Run an app in production | Deploy to production |
| Monitor, retry, cancel, or scale work | Operate an app |
| Diagnose a failure | Troubleshooting |
| Update the framework version | Upgrade OpenShop |
For all options and defaults, use the reference.