SDK for Saleor Apps

SDK for building great Saleor Apps.

🚨 Alpha phase

App SDK is on early, alpha stage at the moment. Every API below 1.x.x release is likely to change.

Feel free to play with SDK and to move its code to your app directly

Installing

npm i @saleor/app-sdk

Docs

• AppBridge - communication layer between Saleor App and Dashboard
• Protected Views - protecting access to App outside of Dashboard
• APL - an interface that enabled App communicating between one or more Saleor instances
• Debugging - how to debug app-sdk behaviour
• Next.js API Handlers - factories for building Next.js API routes
• Protected Views - how to ensure a page is visible only in Dashboard context
• Building a Webhook - how to build a webhook that reacts on Saleor async events or Saleor sync events
• Settings Manager - how to save App configuration (tokens, settings) in Saleor, without external database

Development

How to link development version to your project

If you would like to develop the SDK and test it with existing project:

1. In the Saleor App SDK directory run command

pnpm watch

Now any code change will trigger build operation automatically.

2. In your project directory:

pnpm add ../saleor-app-sdk/dist

As path to your local copy of the App SDK may be different, adjust it accordingly.

Code style

Before committing the code, Git pre-hooks will check staged changes for following the code styles. If you would like to format the code by yourself, run the command:

pnpm lint