Using the Storefront SDK
The Storefront SDK is a set of packages and starter apps for building storefronts on Propeller. Every layer works in any JavaScript or TypeScript project:
- SDK services — the typed GraphQL client and a service per operation.
- UI libraries — ready-made commerce components and headless hooks for React and Vue.
- Accelerator — complete Next.js, Vue and Nuxt storefronts you scaffold with one command.
Each layer is independently usable. You do not need the Accelerator to use the UI libraries, and you do not need the UI libraries to use the SDK.
Three common approaches
| Approach | What you use | Best for |
|---|---|---|
| Scaffold a boilerplate | The Accelerator (all layers, pre-wired) | Greenfield projects and fast time to market |
| Add packages to your app | The SDK plus the React or Vue UI library | An existing app, or a CMS that owns routing |
| Use the SDK headless | The SDK only | Full control, or a framework without a UI library |
See Choosing your approach for the full decision table.
Start here
- To see a storefront running now, scaffold one with the Next.js Accelerator.
- To add the SDK to an existing app or go deeper on any approach, read the Storefront SDK guides.
To build without the SDK, see Build directly on the GraphQL API.