Using the Storefront SDK
The Storefront SDK provides three layers for building customer-facing experiences on Propeller. Each layer builds on the previous one:
- SDK Services — typed TypeScript services that wrap Propeller's GraphQL API. Works in any JavaScript or TypeScript project.
- UI Components — pre-built e-commerce components (product grids, cart, checkout, account pages and more). Available for React and Vue via npm. Stack-agnostic component documentation available for building in any framework.
- Accelerator — a complete working storefront app. Clone it, configure it, customize it. Available as a Next.js app (
@propeller/accelerator-nextjs), with a Vue version coming.
Each layer is independently usable. You do not need the Accelerator to use UI Components. You do not need UI Components to use SDK Services.
Three common approaches
Partners typically use one of three approaches:
| Approach | What you use | Best for |
|---|---|---|
| Commerce-led | Accelerator (all three layers) | Greenfield projects where speed to market is the priority |
| CMS-led | SDK Services + UI Components | Multi-brand or multi-site environments where the CMS owns all routing |
| SDK-only | SDK Services only | Partners with strict architectural requirements or unsupported frameworks |
See Choosing Your Approach for a full decision table.
This track: getting started with the Accelerator
This getting-started track walks you through cloning and running the Accelerator (the commerce-led approach). This is the fastest path to a working frontend.
- Clone and Run — get the Accelerator running locally with your Propeller environment
- What's Next — where to go from here
If your project uses a CMS-led or SDK-only approach, skip this track and go directly to the Storefront SDK guides.
If you prefer to use your own framework without the SDK, see Using your own Framework.