djkato/saleor-app-sdk-REDIS_APL
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
104 commits 1 branch 0 tags 1 MiB
TypeScript 99.9%
Find a file
Lukasz Ostrowski 69c985bdc1
Merge pull request #39 from saleor/change-debug-import 
Change "debug" package import to use default
2022-08-30 11:56:57 +02:00
.github/workflows downgrade pnpm in cicd 2022-08-11 14:09:04 +02:00
.husky Add husky/lint-staged 2022-07-20 16:33:03 +02:00
docs Add docs about debugging (#37) 2022-08-30 11:53:21 +02:00
src Merge pull request #39 from saleor/change-debug-import 2022-08-30 11:56:57 +02:00
.eslintrc Merge branch 'main' into merge-bridge 2022-08-26 08:46:11 +02:00
.gitignore Add information about alpha version 2022-08-08 14:49:26 +02:00
.npmignore initial commit 2022-05-24 22:16:49 +02:00
.prettierignore Add code formatting 2022-07-20 16:01:20 +02:00
.prettierrc Add code formatting 2022-07-20 16:01:20 +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 Fix export from new modules 2022-08-30 09:17:11 +02:00
pnpm-lock.yaml Install debug package and add debug messages to AppBridge 2022-08-26 09:24:56 +02:00
README.md Add docs about debugging (#37) 2022-08-30 11:53:21 +02:00
tsconfig.json move app-bridge code and tests to app-sdk 2022-08-11 14:03:51 +02:00
vitest.config.ts move app-bridge code and tests to app-sdk 2022-08-11 14:03:51 +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
  • 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