djkato/saleor-app-sdk-REDIS_APL
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
171 commits 1 branch 0 tags 1 MiB
TypeScript 99.9%
Find a file
Krzysztof Wolski bec148e696
Add Upstash APL (#78)
2022-10-12 15:13:57 +02:00
.github/workflows Setup code coverage report to github action (#62) 2022-09-16 11:01:02 +02:00
.husky Add central SaleorApp instance (#71) 2022-10-11 09:40:08 +02:00
docs Add Upstash APL (#78) 2022-10-12 15:13:57 +02:00
src Add Upstash APL (#78) 2022-10-12 15:13:57 +02:00
.eslintrc Add Upstash APL (#78) 2022-10-12 15:13:57 +02:00
.gitignore Ignore vscode workspace settings 2022-09-05 13:05:36 +02:00
.npmignore initial commit 2022-05-24 22:16:49 +02:00
.prettierignore Add Upstash APL (#78) 2022-10-12 15:13:57 +02:00
.prettierrc Add code formatting 2022-07-20 16:01:20 +02:00
.release-it.json Add clean script 2022-09-05 16:38:57 +02:00
CODEOWNERS Add docs about debugging (#37) 2022-08-30 11:53:21 +02:00
LICENSE Create LICENSE 2022-07-20 17:11:54 +02:00
package.json Add metadata manager (#73) 2022-10-12 13:28:00 +02:00
pnpm-lock.yaml Auth features (#64) 2022-10-05 13:12:19 +02:00
README.md Add doc about protected views (#66) 2022-10-05 14:56:22 +02:00
tsconfig.json move app-bridge code and tests to app-sdk 2022-08-11 14:03:51 +02:00
tsup.config.ts Add metadata manager (#73) 2022-10-12 13:28:00 +02:00
vitest.config.ts Setup code coverage report to github action (#62) 2022-09-16 11:01:02 +02:00

README.md

SDK for Saleor Apps

SDK for building great Saleor Apps.

npm version badge npm downloads count

🚨 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

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.

  1. 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