create-shoplayer

Scaffold a new ShopLayer project — a Shopify app built with React 19 Server Components on Cloudflare Workers.

Usage

npm create shoplayer my-app
# or
pnpm create shoplayer my-app
yarn create shoplayer my-app
bun create shoplayer my-app

Then:

cd my-app
npm install

# No Shopify account? Start in mock mode:
npx shoplayer dev --mock

# Have a Partner account? Link and run against real Shopify:
npx shoplayer config link
npx shoplayer dev

The scaffolder detects your package manager from how you invoked it (npm / pnpm / yarn / bun) and writes the matching lockfile setup.

What gets scaffolded

my-app/
├── src/
│   ├── pages/
│   │   ├── _layout.tsx               # Root layout with a navMenu export
│   │   └── index.tsx                 # Home page
│   └── webhooks/
│       ├── app.uninstalled.ts        # Session cleanup on uninstall
│       ├── app.scopes-update.ts      # Keep granted scopes in sync
│       ├── customers.data-request.ts # ┐
│       ├── customers.redact.ts       # ├ mandatory GDPR/CCPA compliance webhooks
│       └── shop.redact.ts            # ┘
├── shoplayer.config.ts               # defineConfig({ ... })
├── shopify.app.toml                  # Shopify app configuration
├── wrangler.jsonc                    # Cloudflare Workers configuration
├── graphql.config.yml                # GraphQL codegen / IDE support
├── tsconfig.json
├── .gitignore
├── .npmrc
└── package.json                      # @shoplayer/framework + postinstall codegen

Everything else is convention-based: add files under src/pages/, src/databases/, src/webhooks/, src/proxy/, src/jobs/, and src/locales/ and ShopLayer auto-discovers them — no route registration or config wiring.

Options

create-shoplayer --help      # Usage
create-shoplayer --version   # Scaffolder version

Documentation

• Getting Started
• ShopLayer docs

License

MIT