@propeller-commerce/create-propeller-shop

Scaffold a new Propeller Commerce shop in minutes: pick a stack, pick a mode, pick a CMS, answer a few prompts, and get a working storefront wired to the Propeller GraphQL backend.

Quick start

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

Published under the scoped name @propeller-commerce/create-propeller-shop, so the npx invocation must include the scope. The executable it installs is still create-propeller-shop.

Pick another stack:

npx @propeller-commerce/create-propeller-shop@latest my-vue-shop  --stack=vue  --mode=hybrid
npx @propeller-commerce/create-propeller-shop@latest my-nuxt-shop --stack=nuxt --mode=hybrid

Then:

cd my-shop/frontend
cp .env.local.example .env.local   # .env.example / .env for vue + nuxt
npm install
npm run dev

Stacks

| --stack | Framework | |---|---| | next | Next 16 + React | | vue | Vue 3 + Vite SSR | | nuxt | Nuxt 3 SSR |

Modes

| --mode | Account routes | Portal default | Register form | |---|---|---|---| | b2b | + quotes, authorization, contacts | semi-closed | Contact only | | b2c | universal only | open | Customer only | | hybrid | + quotes, authorization, contacts (gated at runtime) | open | Both |

Run npx @propeller-commerce/create-propeller-shop --help for the full flag list, or omit flags to be prompted interactively.

License

MIT