Skip to main content

Accelerator quickstart

Get a complete storefront running locally against your Propeller environment in three steps. The create-propeller-shop CLI clones a boilerplate for Next.js, Vue or Nuxt, applies your answers and installs everything from public npm. No repository access is needed. Pick your stack in the tabs below.

Prerequisites​

  • Node.js 22
  • A Propeller tenant with two API keys: one for the storefront and an order-editor key. See Keys and security for what each may do, and Environments and access for creating them.
  • The id of the Channel the storefront sells on

Step 1: Scaffold the storefront​

npx @propeller-commerce/create-propeller-shop@latest my-shop --stack=next --mode=hybrid --cms=none

Leave out the flags to answer the prompts instead. The CLI creates the my-shop/ folder, installs the dependencies and makes a first git commit. See Accelerator for every flag.

Step 2: Configure your environment​

Copy the settings example and fill in your values. The example explains every setting in comments.

cd my-shop
cp .env.local.example .env.local

In .env.local, set:

  • BOILERPLATE_GRAPHQL_ENDPOINT: your GraphQL API URL
  • BOILERPLATE_API_KEY and BOILERPLATE_ORDER_EDITOR_API_KEY: the storefront key and the order-editor key
  • NEXT_PUBLIC_CHANNEL_ID: your Channel id

The keys stay on the server: the browser talks to the shop's own /api/graphql route, which adds them. See Keys and security.

Step 3: Start the dev server​

npm run dev

Open http://localhost:3000.

You should see your catalog, navigation and search, backed by your Propeller environment.

Next steps​

Last updated on