71 lines
2.3 KiB
Markdown
71 lines
2.3 KiB
Markdown
<div align="center">
|
|
|
|
[](https://discord.gg/H52JTZAtSH)
|
|
|
|
</div>
|
|
|
|
# SDK for Saleor Apps
|
|
|
|
SDK for building great [Saleor Apps](https://github.com/saleor/apps).
|
|
|
|
<div>
|
|
|
|
[](https://www.npmjs.com/package/@saleor/app-sdk)
|
|
[](https://www.npmjs.com/package/@saleor/app-sdk)
|
|
|
|
</div>
|
|
|
|
## 🚨 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
|
|
|
|
```bash
|
|
npm i @saleor/app-sdk
|
|
```
|
|
|
|
## Docs
|
|
|
|
- [AppBridge](./docs/app-bridge.md) - communication layer between Saleor App and Dashboard
|
|
- [Protected Views](./docs/protected-views.md) - protecting access to App outside of Dashboard
|
|
- [APL](./docs/apl.md) - an interface that enabled App communicating between one or more Saleor instances
|
|
- [Debugging](./docs/debugging.md) - how to debug app-sdk behaviour
|
|
- [Next.js API Handlers](./docs/api-handlers.md) - factories for building Next.js API routes
|
|
- [Protected Views](./docs/protected-views.md) - how to ensure a page is visible only in Dashboard context
|
|
- [Building a Webhook](./docs/saleor-webhook.md) - how to build a webhook that reacts on [Saleor async events](https://docs.saleor.io/docs/3.x/developer/extending/apps/asynchronous-webhooks) or [Saleor sync events](https://docs.saleor.io/docs/3.x/developer/extending/apps/synchronous-webhooks/key-concepts)
|
|
- [Settings Manager](./docs/settings-manager.md) - 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
|
|
|
|
```bash
|
|
pnpm watch
|
|
```
|
|
|
|
Now any code change will trigger build operation automatically.
|
|
|
|
2. In your project directory:
|
|
|
|
```bash
|
|
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:
|
|
|
|
```bash
|
|
pnpm lint
|
|
```
|