No description
Find a file
Krzysztof Wolski f84d53465f
Merge pull request #28 from saleor/apl-interface
Introduce APL interface
2022-08-25 19:45:40 +02:00
.github/workflows Update the GitHub action 2022-08-10 10:57:07 +02:00
.husky Add husky/lint-staged 2022-07-20 16:33:03 +02:00
docs Introduce APL interface 2022-08-25 16:49:54 +02:00
src Merge pull request #28 from saleor/apl-interface 2022-08-25 19:45:40 +02:00
.eslintrc Introduce APL interface 2022-08-25 16:49:54 +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
LICENSE Create LICENSE 2022-07-20 17:11:54 +02:00
package.json Introduce APL interface 2022-08-25 16:49:54 +02:00
pnpm-lock.yaml Update dependencies 2022-08-10 10:59:48 +02:00
README.md Add information about alpha version 2022-08-08 14:49:26 +02:00
tsconfig.json Apply code formatting 2022-07-20 16:19:49 +02:00

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

Development

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