Skip to main content

Scaffold and run

Get a working storefront running locally against your Propeller environment. 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 shop​

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

Run it without flags to answer the prompts interactively. The main flags:

  • --stack — next, vue or nuxt
  • --mode — b2b, b2c or hybrid
  • --cms — strapi, cms or none

See Accelerator for the full flag list. The CLI creates the my-shop/ project and installs dependencies. Because this example uses --cms=none, the app is placed directly in my-shop/; selecting a CMS instead puts the app under my-shop/frontend next to a my-shop/cms folder.

Step 2: Configure your environment​

cd my-shop
cp .env.local.example .env.local   # Next.js; for Vue and Nuxt copy .env.example to .env

With a CMS selected, change into my-shop/frontend instead. Open the environment file and set your GraphQL endpoint and API key. The 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 the dev URL for your stack: Next.js at http://localhost:3000, Vue at http://localhost:5173, Nuxt at http://localhost:5000. You should see your catalog, navigation and search backed by your Propeller environment.

Next steps​

Continue to What's next for where to go from here.