Skip to main content

Next.js Accelerator

Get a complete Next.js storefront running locally against your Propeller environment in three steps. The create-propeller-shop CLI clones a boilerplate, wires it to your answers and installs everything from public npm. No repository access request is needed.

Prerequisites​

  • Node.js 20 or higher
  • A Propeller tenant with a GraphQL API key (see Environments and access)
  • The base category id you want as the storefront's root, from your catalog

See Prerequisites for where to obtain each.

Step 1: Scaffold the storefront​

npx @propeller-commerce/create-propeller-shop@latest my-shop

Answer the prompts to choose your stack, shop mode and CMS. Keep the default next stack for a Next.js storefront. You can also pass the answers as flags:

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

See Accelerator for the full flag list. The CLI creates the my-shop/ project and installs dependencies. With --cms=none the app sits directly in my-shop/; selecting a CMS instead puts the app under my-shop/frontend.

Step 2: Configure your environment​

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

Open .env.local and set your GraphQL endpoint, API key and base category id. The API key stays server-side: the browser talks to a local /api/graphql proxy that injects it. The committed environment example documents every variable inline.

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​