App SDK Overview
@saleor/app-sdk is a TypeScript-first npm library that serves as a foundation for every Saleor app. It includes helpers built for React and Next.js.
You can find @saleor/app-sdk on npm and GitHub.
warning
@saleor/app-sdk only supports Next.js. We can't guarantee it will work with other frameworks.
Installation
Install @saleor/app-sdk by running the following command:
# Preferred - with pnpm
pnpm add @saleor/app-sdk
# With npm and yarn
npm i @saleor/app-sdk
yarn add @saleor/app-sdk
Versioning
@saleor/app-sdk uses semver. We track its releases and changelogs on GitHub.
Currently, the SDK is in the pre-1.0 phase, meaning the API is unstable. We do our best to minimize breaking changes.
Learn more
If you are interested in building Saleor apps using @saleor/app-sdk, you may want to check out the following resources: