Onboarding App
The Onboarding App provides a "Welcome / Onboarding" widget on the Dashboard home page. It guides new users through first-run tasks such as creating a product, exploring orders, opening the GraphQL playground, browsing extensions, and inviting staff.
It replaces the Dashboard's old built-in home screen ("welcome page") onboarding. The widget was ported into a standalone Saleor App so onboarding can ship and evolve independently of Dashboard releases.
How it works​
- UI / frontend only. The app runs entirely in the browser inside the Dashboard. It has no backend logic, no webhooks, and no APL — the only server endpoint it exposes is the app manifest.
- It mounts as a
HOMEPAGE_WIDGETSextension, so it appears as a widget on the Dashboard home page. - All GraphQL calls run in the browser using the staff user's token provided by App Bridge.
- Completion state is stored under the user metadata key
onboarding(compatible with the Dashboard widget's existing key), so progress is remembered per user.
Can be safely uninstalled​
Because the app only renders UI and stores no data of its own, it can be safely uninstalled at any time. Removing it simply hides the onboarding widget from the Dashboard home page; no store data, orders, or configuration are affected.
Permissions required by the app​
The app requests no permissions in its manifest. It operates with the permissions of the staff user viewing the Dashboard.
Development​
To run the application locally, follow the Running Saleor Apps locally article.