Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Introducing `create-spree-app` CLI tool (#13652)

Damian Legawiec1f0aa82e42dc
diff --git a/.github/workflows/packages.yml b/.github/workflows/packages.yml
index 96e34fd05e..00f87dc71f 100644
--- a/.github/workflows/packages.yml
+++ b/.github/workflows/packages.yml
@@ -127,3 +127,47 @@ jobs:
- name: Build and Publish
if: steps.check.outputs.published == 'false'
run: pnpm turbo build --filter=@spree/next && npm publish --provenance --access public
+
+ release-create-spree-app:
+ name: "create-spree-app - Release"
+ needs: check
+ if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+ runs-on: ubuntu-latest
+ permissions:
+ contents: write
+ pull-requests: write
+ id-token: write
+ defaults:
+ run:
+ working-directory: packages/create-spree-app
+ steps:
+ - uses: actions/checkout@v4
+
+ - uses: pnpm/action-setup@v4
+
+ - uses: actions/setup-node@v4
+ with:
+ node-version: 20
+ cache: pnpm
+ registry-url: https://registry.npmjs.org
+
+ - run: pnpm install --frozen-lockfile
+ working-directory: .
+
+ - name: Upgrade npm for Trusted Publishing support
+ run: npm install -g npm@latest
+ working-directory: .
+
+ - name: Check if version is published
+ id: check
+ run: |
+ PACKAGE_VERSION=$(node -p "require('./package.json').version")
+ if npm view create-spree-app@$PACKAGE_VERSION version 2>/dev/null; then
+ echo "published=true" >> $GITHUB_OUTPUT
+ else
+ echo "published=false" >> $GITHUB_OUTPUT
+ fi
+
+ - name: Build and Publish
+ if: steps.check.outputs.published == 'false'
+ run: pnpm build && npm publish --provenance --access public
diff --git a/packages/create-spree-app/.gitignore b/packages/create-spree-app/.gitignore
new file mode 100644
index 0000000000..dd6e803c7f
--- /dev/null
+++ b/packages/create-spree-app/.gitignore
@@ -0,0 +1,4 @@
+node_modules/
+dist/
+*.log
+.DS_Store
diff --git a/packages/create-spree-app/package.json b/packages/create-spree-app/package.json
new file mode 100644
index 0000000000..d0fdcc4d47
--- /dev/null
+++ b/packages/create-spree-app/package.json
@@ -0,0 +1,58 @@
+{
+ "name": "create-spree-app",
+ "version": "0.1.0",
+ "description": "Create a new Spree Commerce project with a single command",
+ "type": "module",
+ "bin": "./dist/index.js",
+ "files": [
+ "dist",
+ "README.md"
+ ],
+ "scripts": {
+ "build": "tsup",
+ "dev": "tsup --watch",
+ "test": "vitest run",
+ "typecheck": "tsc --noEmit",
+ "clean": "rm -rf dist",
+ "prepublishOnly": "npm run build"
+ },
+ "keywords": [
+ "spree",
+ "commerce",
+ "ecommerce",
+ "scaffold",
+ "create",
+ "cli",
+ "docker",
+ "nextjs",
+ "typescript",
+ "headless"
+ ],
+ "author": "Vendo Connect Inc.",
+ "license": "MIT",
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/spree/spree.git",
+ "directory": "packages/create-spree-app"
+ },
+ "homepage": "https://spreecommerce.org",
+ "bugs": {
+ "url": "https://github.com/spree/spree/issues"
+ },
+ "dependencies": {
+ "@clack/prompts": "^0.10.0",
+ "commander": "^13.1.0",
+ "execa": "^9.5.2",
+ "giget": "^2.0.0",
+ "picocolors": "^1.1.1"
+ },
+ "devDependencies": {
+ "@types/node": "^20.0.0",
+ "tsup": "^8.0.0",
+ "typescript": "^5.3.0",
+ "vitest": "^4.0.18"
+ },
+ "engines": {
+ "node": ">=20"
+ }
+}
diff --git a/packages/create-spree-app/src/constants.ts b/packages/create-spree-app/src/constants.ts
new file mode 100644
index 0000000000..f07dec94e9
--- /dev/null
+++ b/packages/create-spree-app/src/constants.ts
@@ -0,0 +1,13 @@
+export const SPREE_IMAGE = 'ghcr.io/spree/spree'
+export const SPREE_VERSION_TAG = 'latest'
+export const SPREE_PORT = 3000
+export const STOREFRONT_PORT = 3001
+
+export const HEALTH_CHECK_URL = `http://localhost:${SPREE_PORT}/up`
+export const HEALTH_CHECK_INTERVAL_MS = 3000
+export const HEALTH_CHECK_TIMEOUT_MS = 120_000
+
+export const STOREFRONT_REPO = 'github:spree/nextjs-starter-spree'
+
+export const DEFAULT_ADMIN_EMAIL = '[email protected]'
+export const DEFAULT_ADMIN_PASSWORD = 'spree123'
diff --git a/packages/create-spree-app/src/docker.ts b/packages/create-spree-app/src/docker.ts
new file mode 100644
index 0000000000..e9e7ce3806
--- /dev/null
+++ b/packages/create-spree-app/src/docker.ts
@@ -0,0 +1,51 @@
+import { execa } from 'execa'
+import { HEALTH_CHECK_URL, HEALTH_CHECK_INTERVAL_MS, HEALTH_CHECK_TIMEOUT_MS } from './constants.js'
+
+export async function startServices(projectDir: string): Promise<void> {
+ await execa('docker', ['compose', 'up', '-d'], { cwd: projectDir, stdio: 'ignore' })
+}
+
+export async function waitForHealthy(): Promise<void> {
+ const start = Date.now()
+
+ while (Date.now() - start < HEALTH_CHECK_TIMEOUT_MS) {
+ try {
+ const res = await fetch(HEALTH_CHECK_URL)
+ if (res.ok) return
+ } catch {
+ // not ready yet
+ }
+ await sleep(HEALTH_CHECK_INTERVAL_MS)
+ }
+
+ throw new Error(`Spree did not become healthy within ${HEALTH_CHECK_TIMEOUT_MS / 1000}s`)
+}
+
+export async function fetchApiKey(projectDir: string): Promise<string> {
+ const script = [
+ 'store = Spree::Store.default;',
+ 'key = store.api_keys.active.publishable.first ||',
+ " store.api_keys.create!(name: 'Default', key_type: 'publishable');",
+ 'print key.token',
+ ].join(' ')
+
+ const { stdout } = await execa(
+ 'docker',
+ ['compose', 'exec', '-T', 'spree', 'bin/rails', 'runner', script],
+ { cwd: projectDir },
+ )
+
+ return stdout.trim()
+}
+
+export async function loadSampleData(projectDir: string): Promise<void> {
+ await execa(
+ 'docker',
+ ['compose', 'exec', '-T', 'spree', 'bin/rails', 'spree:load_sample_data'],
+ { cwd: projectDir, stdio: 'ignore' },
+ )
+}
+
+function sleep(ms: number): Promise<void> {
+ return new Promise((resolve) => setTimeout(resolve, ms))
+}
diff --git a/packages/create-spree-app/src/index.ts b/packages/create-spree-app/src/index.ts
new file mode 100644
index 0000000000..33d99a3941
--- /dev/null
+++ b/packages/create-spree-app/src/index.ts
@@ -0,0 +1,49 @@
+import { Command } from 'commander'
+import * as p from '@clack/prompts'
+import pc from 'picocolors'
+import { runPrompts } from './prompts.js'
+import { scaffold } from './scaffold.js'
+import { detectPackageManager } from './utils.js'
+import type { PackageManager } from './types.js'
+
+const program = new Command()
+ .name('create-spree-app')
+ .description('Create a new Spree Commerce project')
+ .argument('[directory]', 'project directory')
+ .option('--backend-only', 'skip storefront setup')
+ .option('--no-sample-data', 'skip loading sample data')
+ .option('--no-start', 'do not start Docker services')
+ .option('--use-npm', 'use npm as package manager')
+ .option('--use-yarn', 'use yarn as package manager')
+ .option('--use-pnpm', 'use pnpm as package manager')
+ .action(async (directory: string | undefined, flags: Record<string, unknown>) => {
+ p.intro(pc.bold('Create Spree App'))
+
+ let packageManager: PackageManager = detectPackageManager()
+ if (flags.useNpm) packageManager = 'npm'
+ if (flags.useYarn) packageManager = 'yarn'
+ if (flags.usePnpm) packageManager = 'pnpm'
+
+ try {
+ const options = await runPrompts({
+ directory,
+ backendOnly: flags.backendOnly as boolean | undefined,
+ noSampleData: flags.sampleData === false ? true : undefined,
+ noStart: flags.start === false ? true : undefined,
+ packageManager,
+ })
+
+ await scaffold(options)
+
+ p.outro('Happy selling!')
+ } catch (err) {
+ if (err instanceof Error && err.message.includes('cancelled')) {
+ p.cancel('Setup cancelled.')
+ process.exit(0)
+ }
+ p.cancel(err instanceof Error ? err.message : 'An unexpected error occurred.')
+ process.exit(1)
+ }
+ })
+
+program.parse()
diff --git a/packages/create-spree-app/src/prompts.ts b/packages/create-spree-app/src/prompts.ts
new file mode 100644
index 0000000000..a35e995544
--- /dev/null
+++ b/packages/create-spree-app/src/prompts.ts
@@ -0,0 +1,88 @@
+import * as p from '@clack/prompts'
+import type { ScaffoldOptions, SetupMode, PackageManager } from './types.js'
+
+interface PromptFlags {
+ directory?: string
+ backendOnly?: boolean
+ noSampleData?: boolean
+ noStart?: boolean
+ packageManager?: PackageManager
+}
+
+export async function runPrompts(flags: PromptFlags): Promise<ScaffoldOptions> {
+ const directory =
+ flags.directory ??
+ ((await p.text({
+ message: 'Where would you like to create your project?',
+ placeholder: './my-store',
+ defaultValue: './my-store',
+ validate(value): string | undefined {
+ if (!value) return 'Please enter a directory'
+ return undefined
+ },
+ })) as string)
+
+ if (p.isCancel(directory)) {
+ p.cancel('Setup cancelled.')
+ process.exit(0)
+ }
+
+ let mode: SetupMode
+ if (flags.backendOnly !== undefined) {
+ mode = flags.backendOnly ? 'backend-only' : 'full-stack'
+ } else {
+ const modeResult = await p.select({
+ message: 'What would you like to set up?',
+ options: [
+ { value: 'full-stack', label: 'Full-stack (Backend + Storefront)' },
+ { value: 'backend-only', label: 'Backend only' },
+ ],
+ })
+
+ if (p.isCancel(modeResult)) {
+ p.cancel('Setup cancelled.')
+ process.exit(0)
+ }
+ mode = modeResult as SetupMode
+ }
+
+ let sampleData: boolean
+ if (flags.noSampleData !== undefined) {
+ sampleData = !flags.noSampleData
+ } else {
+ const sampleResult = await p.confirm({
+ message: 'Include sample data? (products, categories, images)',
+ initialValue: true,
+ })
+
+ if (p.isCancel(sampleResult)) {
+ p.cancel('Setup cancelled.')
+ process.exit(0)
+ }
+ sampleData = sampleResult
+ }
+
+ let start: boolean
+ if (flags.noStart !== undefined) {
+ start = !flags.noStart
+ } else {
+ const startResult = await p.confirm({
+ message: 'Start services now? (requires Docker)',
+ initialValue: true,
+ })
+
+ if (p.isCancel(startResult)) {
+ p.cancel('Setup cancelled.')
+ process.exit(0)
+ }
+ start = startResult
+ }
+
+ return {
+ directory,
+ mode,
+ sampleData,
+ start,
+ packageManager: flags.packageManager ?? 'npm',
+ }
+}
diff --git a/packages/create-spree-app/src/scaffold.ts b/packages/create-spree-app/src/scaffold.ts
new file mode 100644
index 0000000000..f761ae9930
--- /dev/null
+++ b/packages/create-spree-app/src/scaffold.ts
@@ -0,0 +1,164 @@
+import * as p from '@clack/prompts'
+import pc from 'picocolors'
+import fs from 'node:fs'
+import path from 'node:path'
+import type { ScaffoldOptions } from './types.js'
+import { SPREE_PORT, STOREFRONT_PORT, DEFAULT_ADMIN_EMAIL, DEFAULT_ADMIN_PASSWORD } from './constants.js'
+import { generateSecretKeyBase, isDockerRunning } from './utils.js'
+import { dockerComposeContent } from './templates/docker-compose.js'
+import { envContent } from './templates/env.js'
+import { rootPackageJsonContent } from './templates/package-json.js'
+import { readmeContent } from './templates/readme.js'
+import { gitignoreContent } from './templates/gitignore.js'
+import { startServices, waitForHealthy, fetchApiKey, loadSampleData } from './docker.js'
+import { downloadStorefront, installStorefrontDeps, writeStorefrontEnv } from './storefront.js'
+
+export async function scaffold(options: ScaffoldOptions): Promise<void> {
+ const projectDir = path.resolve(options.directory)
+ const projectName = path.basename(projectDir)
+ const isFullStack = options.mode === 'full-stack'
+
+ // Pre-flight checks
+ if (options.start) {
+ const dockerRunning = await isDockerRunning()
+ if (!dockerRunning) {
+ p.cancel('Docker is not running. Please start Docker and try again, or use --no-start.')
+ process.exit(1)
+ }
+ }
+
+ if (fs.existsSync(projectDir)) {
+ const entries = fs.readdirSync(projectDir)
+ if (entries.length > 0) {
+ p.cancel(`Directory ${pc.bold(options.directory)} is not empty.`)
+ process.exit(1)
+ }
+ }
+
+ // Phase 1: Generate project files
+ const s = p.spinner()
+
+ s.start('Creating project structure...')
+
+ fs.mkdirSync(projectDir, { recursive: true })
+ fs.writeFileSync(path.join(projectDir, 'docker-compose.yml'), dockerComposeContent())
+ fs.writeFileSync(path.join(projectDir, '.env'), envContent(generateSecretKeyBase()))
+ fs.writeFileSync(path.join(projectDir, 'package.json'), rootPackageJsonContent(projectName))
+ fs.writeFileSync(path.join(projectDir, 'README.md'), readmeContent(projectName, isFullStack))
+ fs.writeFileSync(path.join(projectDir, '.gitignore'), gitignoreContent())
+
+ s.stop('Project structure created.')
+
+ // Phase 2: Storefront
+ if (isFullStack) {
+ s.start('Downloading storefront template...')
+ await downloadStorefront(projectDir)
+ s.stop('Storefront template downloaded.')
+
+ writeStorefrontEnv(projectDir)
+
+ s.start('Installing storefront dependencies...')
+ await installStorefrontDeps(projectDir, options.packageManager)
+ s.stop('Storefront dependencies installed.')
+ }
+
+ // Phase 3: Docker
+ if (options.start) {
+ s.start('Starting Docker services...')
+ await startServices(projectDir)
+ s.stop('Docker services started.')
+
+ s.start('Waiting for Spree to be ready...')
+ await waitForHealthy()
+ s.stop('Spree is ready.')
+
+ let apiKey: string | undefined
+
+ s.start('Configuring API key...')
+ apiKey = await fetchApiKey(projectDir)
+ s.stop(`API key: ${pc.cyan(apiKey)}`)
+
+ if (isFullStack && apiKey) {
+ writeStorefrontEnv(projectDir, apiKey)
+ }
+
+ if (options.sampleData) {
+ s.start('Loading sample data...')
+ await loadSampleData(projectDir)
+ s.stop('Sample data loaded.')
+ }
+
+ printSuccessWithDocker(projectDir, projectName, isFullStack, apiKey)
+ } else {
+ printSuccessWithoutDocker(projectDir, projectName, isFullStack)
+ }
+}
+
+function printSuccessWithDocker(
+ _projectDir: string,
+ projectName: string,
+ isFullStack: boolean,
+ apiKey?: string,
+): void {
+ const lines: string[] = [
+ '',
+ `${pc.bold('Admin Dashboard')}`,
+ ` ${pc.cyan(`http://localhost:${SPREE_PORT}/admin`)}`,
+ ` Email: ${DEFAULT_ADMIN_EMAIL}`,
+ ` Password: ${DEFAULT_ADMIN_PASSWORD}`,
+ ]
+
+ if (isFullStack) {
+ lines.push(
+ '',
+ `${pc.bold('Storefront')}`,
+ ` Run: ${pc.cyan(`cd ${projectName}/apps/storefront && npm run dev`)}`,
+ ` Open: ${pc.cyan(`http://localhost:${STOREFRONT_PORT}`)}`,
+ )
+ }
+
+ lines.push(
+ '',
+ `${pc.bold('Store API')}`,
+ ` ${pc.cyan(`http://localhost:${SPREE_PORT}/api/v3/store`)}`,
+ )
+
+ if (apiKey) {
+ lines.push(` API Key: ${pc.cyan(apiKey)}`)
+ }
+
+ p.note(lines.join('\n'), 'Your Spree store is ready!')
+}
+
+function printSuccessWithoutDocker(
+ _projectDir: string,
+ projectName: string,
+ isFullStack: boolean,
+): void {
+ const lines: string[] = [
+ '',
+ `${pc.bold('Next steps:')}`,
+ ` cd ${projectName}`,
+ ` docker compose up -d`,
+ ]
+
+ if (isFullStack) {
+ lines.push(
+ '',
+ ` ${pc.dim('# In another terminal:')}`,
+ ` cd ${projectName}/apps/storefront`,
+ ` npm install`,
+ ` npm run dev`,
+ )
+ }
+
+ lines.push(
+ '',
+ `${pc.bold('Admin Dashboard')}`,
+ ` http://localhost:${SPREE_PORT}/admin`,
+ ` Email: ${DEFAULT_ADMIN_EMAIL}`,
+ ` Password: ${DEFAULT_ADMIN_PASSWORD}`,
+ )
+
+ p.note(lines.join('\n'), 'Project created!')
+}
diff --git a/packages/create-spree-app/src/storefront.ts b/packages/create-spree-app/src/storefront.ts
new file mode 100644
index 0000000000..f00c4014e5
--- /dev/null
+++ b/packages/create-spree-app/src/storefront.ts
@@ -0,0 +1,24 @@
+import { downloadTemplate } from 'giget'
+import fs from 'node:fs'
+import path from 'node:path'
+import { execa } from 'execa'
+import { STOREFRONT_REPO } from './constants.js'
+import { storefrontEnvContent } from './templates/env.js'
+import { installCommand } from './utils.js'
+import type { PackageManager } from './types.js'
+
+export async function downloadStorefront(projectDir: string): Promise<void> {
+ const storefrontDir = path.join(projectDir, 'apps', 'storefront')
+ await downloadTemplate(STOREFRONT_REPO, { dir: storefrontDir, force: true })
+}
+
+export async function installStorefrontDeps(projectDir: string, pm: PackageManager): Promise<void> {
+ const storefrontDir = path.join(projectDir, 'apps', 'storefront')
+ const [cmd, ...args] = installCommand(pm).split(' ')
+ await execa(cmd, args, { cwd: storefrontDir, stdio: 'ignore' })
+}
+
+export function writeStorefrontEnv(projectDir: string, apiKey?: string): void {
+ const envPath = path.join(projectDir, 'apps', 'storefront', '.env.local')
+ fs.writeFileSync(envPath, storefrontEnvContent(apiKey))
+}
diff --git a/packages/create-spree-app/src/templates/docker-compose.ts b/packages/create-spree-app/src/templates/docker-compose.ts
new file mode 100644
index 0000000000..7cb9758c2f
--- /dev/null
+++ b/packages/create-spree-app/src/templates/docker-compose.ts
@@ -0,0 +1,39 @@
+import { SPREE_IMAGE, SPREE_VERSION_TAG } from '../constants.js'
+
+export function dockerComposeContent(): string {
+ return `services:
+ postgres:
+ image: postgres:17-alpine
+ environment:
+ POSTGRES_HOST_AUTH_METHOD: trust
+ volumes:
+ - postgres_data:/var/lib/postgresql/data
+ healthcheck:
+ test: pg_isready -U postgres
+ interval: 5s
+ timeout: 5s
+ retries: 5
+
+ spree:
+ image: ${SPREE_IMAGE}:${SPREE_VERSION_TAG}
+ depends_on:
+ postgres:
+ condition: service_healthy
+ environment:
+ DATABASE_HOST: postgres
+ SECRET_KEY_BASE: \${SECRET_KEY_BASE}
+ RAILS_ENV: production
+ RAILS_LOG_TO_STDOUT: "true"
+ ports:
+ - "3000:3000"
+ healthcheck:
+ test: curl -f http://localhost:3000/up || exit 1
+ interval: 10s
+ timeout: 5s
+ retries: 10
+ start_period: 30s
+
+volumes:
+ postgres_data:
+`
+}
diff --git a/packages/create-spree-app/src/templates/env.ts b/packages/create-spree-app/src/templates/env.ts
new file mode 100644
index 0000000000..60a6d66256
--- /dev/null
+++ b/packages/create-spree-app/src/templates/env.ts
@@ -0,0 +1,13 @@
+import { SPREE_PORT, SPREE_VERSION_TAG } from '../constants.js'
+
+export function envContent(secretKeyBase: string): string {
+ return `SECRET_KEY_BASE=${secretKeyBase}
+SPREE_VERSION_TAG=${SPREE_VERSION_TAG}
+`
+}
+
+export function storefrontEnvContent(apiKey?: string): string {
+ return `NEXT_PUBLIC_SPREE_API_URL=http://localhost:${SPREE_PORT}
+NEXT_PUBLIC_SPREE_PUBLISHABLE_KEY=${apiKey ?? 'pk_REPLACE_ME_AFTER_DOCKER_START'}
+`
+}
diff --git a/packages/create-spree-app/src/templates/gitignore.ts b/packages/create-spree-app/src/templates/gitignore.ts
new file mode 100644
index 0000000000..c58965aedc
--- /dev/null
+++ b/packages/create-spree-app/src/templates/gitignore.ts
@@ -0,0 +1,7 @@
+export function gitignoreContent(): string {
+ return `node_modules/
+.env
+.env.local
+.DS_Store
+`
+}
diff --git a/packages/create-spree-app/src/templates/package-json.ts b/packages/create-spree-app/src/templates/package-json.ts
new file mode 100644
index 0000000000..29744158b0
--- /dev/null
+++ b/packages/create-spree-app/src/templates/package-json.ts
@@ -0,0 +1,16 @@
+export function rootPackageJsonContent(name: string): string {
+ const pkg = {
+ name,
+ private: true,
+ scripts: {
+ dev: 'docker compose up -d',
+ down: 'docker compose down',
+ logs: 'docker compose logs -f spree',
+ 'seed': 'docker compose exec spree bin/rails db:seed',
+ 'load-sample-data': 'docker compose exec spree bin/rails spree:load_sample_data',
+ console: 'docker compose exec spree bin/rails c',
+ },
+ }
+
+ return JSON.stringify(pkg, null, 2) + '\n'
+}
diff --git a/packages/create-spree-app/src/templates/readme.ts b/packages/create-spree-app/src/templates/readme.ts
new file mode 100644
index 0000000000..818bc269d2
--- /dev/null
+++ b/packages/create-spree-app/src/templates/readme.ts
@@ -0,0 +1,61 @@
+import { SPREE_PORT, STOREFRONT_PORT, DEFAULT_ADMIN_EMAIL, DEFAULT_ADMIN_PASSWORD } from '../constants.js'
+
+export function readmeContent(name: string, hasStorefront: boolean): string {
+ let content = `# ${name}
+
+A [Spree Commerce](https://spreecommerce.org) project.
+
+## Getting Started
+
+### Prerequisites
+
+- [Docker](https://docs.docker.com/get-docker/) installed and running
+
+### Start the backend
+
+\`\`\`bash
+docker compose up -d
+\`\`\`
+
+Wait for the services to be healthy, then open:
+
+- **Admin Dashboard:** http://localhost:${SPREE_PORT}/admin
+ - Email: \`${DEFAULT_ADMIN_EMAIL}\`
+ - Password: \`${DEFAULT_ADMIN_PASSWORD}\`
+- **Store API:** http://localhost:${SPREE_PORT}/api/v3/store
+`
+
+ if (hasStorefront) {
+ content += `
+### Start the storefront
+
+\`\`\`bash
+cd apps/storefront
+npm install
+npm run dev
+\`\`\`
+
+Open http://localhost:${STOREFRONT_PORT}
+`
+ }
+
+ content += `
+## Useful Commands
+
+| Command | Description |
+|---------|-------------|
+| \`docker compose up -d\` | Start backend services |
+| \`docker compose down\` | Stop backend services |
+| \`docker compose logs -f spree\` | View backend logs |
+| \`docker compose exec spree bin/rails c\` | Rails console |
+| \`docker compose exec spree bin/rails spree:load_sample_data\` | Load sample products |
+
+## Learn More
+
+- [Spree Documentation](https://docs.spreecommerce.org)
+- [Store API Reference](https://docs.spreecommerce.org/api-reference/store)
+- [Spree GitHub](https://github.com/spree/spree)
+`
+
+ return content
+}
diff --git a/packages/create-spree-app/src/types.ts b/packages/create-spree-app/src/types.ts
new file mode 100644
index 0000000000..c3aec4474f
--- /dev/null
+++ b/packages/create-spree-app/src/types.ts
@@ -0,0 +1,11 @@
+export type SetupMode = 'full-stack' | 'backend-only'
+
+export type PackageManager = 'npm' | 'yarn' | 'pnpm'
+
+export interface ScaffoldOptions {
+ directory: string
+ mode: SetupMode
+ sampleData: boolean
+ start: boolean
+ packageManager: PackageManager
+}
diff --git a/packages/create-spree-app/src/utils.ts b/packages/create-spree-app/src/utils.ts
new file mode 100644
index 0000000000..fd5bc726b4
--- /dev/null
+++ b/packages/create-spree-app/src/utils.ts
@@ -0,0 +1,33 @@
+import { execaCommand } from 'execa'
+import crypto from 'node:crypto'
+import type { PackageManager } from './types.js'
+
+export function detectPackageManager(): PackageManager {
+ const agent = process.env.npm_config_user_agent ?? ''
+ if (agent.startsWith('yarn')) return 'yarn'
+ if (agent.startsWith('pnpm')) return 'pnpm'
+ return 'npm'
+}
+
+export async function isDockerRunning(): Promise<boolean> {
+ try {
+ await execaCommand('docker info', { stdio: 'ignore' })
+ return true
+ } catch {
+ return false
+ }
+}
+
+export function generateSecretKeyBase(): string {
+ return crypto.randomBytes(64).toString('hex')
+}
+
+export function installCommand(pm: PackageManager): string {
+ return pm === 'yarn' ? 'yarn' : `${pm} install`
+}
+
+export function runCommand(pm: PackageManager): string {
+ if (pm === 'npm') return 'npx'
+ if (pm === 'yarn') return 'yarn'
+ return 'pnpm'
+}
diff --git a/packages/create-spree-app/tests/scaffold.test.ts b/packages/create-spree-app/tests/scaffold.test.ts
new file mode 100644
index 0000000000..f8a3f80780
--- /dev/null
+++ b/packages/create-spree-app/tests/scaffold.test.ts
@@ -0,0 +1,128 @@
+import { describe, it, expect, afterEach, vi } from 'vitest'
+import fs from 'node:fs'
+import path from 'node:path'
+import os from 'node:os'
+import { scaffold } from '../src/scaffold'
+
+function createTempDir(): string {
+ return fs.mkdtempSync(path.join(os.tmpdir(), 'create-spree-app-test-'))
+}
+
+describe('scaffold (backend-only, no-start)', () => {
+ const tempDirs: string[] = []
+
+ function getTempProjectDir(): string {
+ const base = createTempDir()
+ const projectDir = path.join(base, 'my-store')
+ tempDirs.push(base)
+ return projectDir
+ }
+
+ afterEach(() => {
+ for (const dir of tempDirs) {
+ fs.rmSync(dir, { recursive: true, force: true })
+ }
+ tempDirs.length = 0
+ })
+
+ it('creates all expected files', async () => {
+ const projectDir = getTempProjectDir()
+
+ await scaffold({
+ directory: projectDir,
+ mode: 'backend-only',
+ sampleData: false,
+ start: false,
+ packageManager: 'npm',
+ })
+
+ expect(fs.existsSync(path.join(projectDir, 'docker-compose.yml'))).toBe(true)
+ expect(fs.existsSync(path.join(projectDir, '.env'))).toBe(true)
+ expect(fs.existsSync(path.join(projectDir, 'package.json'))).toBe(true)
+ expect(fs.existsSync(path.join(projectDir, 'README.md'))).toBe(true)
+ expect(fs.existsSync(path.join(projectDir, '.gitignore'))).toBe(true)
+ })
+
+ it('generates docker-compose with Spree image', async () => {
+ const projectDir = getTempProjectDir()
+
+ await scaffold({
+ directory: projectDir,
+ mode: 'backend-only',
+ sampleData: false,
+ start: false,
+ packageManager: 'npm',
+ })
+
+ const compose = fs.readFileSync(path.join(projectDir, 'docker-compose.yml'), 'utf-8')
+ expect(compose).toContain('ghcr.io/spree/spree')
+ })
+
+ it('generates .env with SECRET_KEY_BASE', async () => {
+ const projectDir = getTempProjectDir()
+
+ await scaffold({
+ directory: projectDir,
+ mode: 'backend-only',
+ sampleData: false,
+ start: false,
+ packageManager: 'npm',
+ })
+
+ const env = fs.readFileSync(path.join(projectDir, '.env'), 'utf-8')
+ expect(env).toMatch(/SECRET_KEY_BASE=.{128}/)
+ })
+
+ it('generates valid package.json with project name', async () => {
+ const projectDir = getTempProjectDir()
+
+ await scaffold({
+ directory: projectDir,
+ mode: 'backend-only',
+ sampleData: false,
+ start: false,
+ packageManager: 'npm',
+ })
+
+ const content = fs.readFileSync(path.join(projectDir, 'package.json'), 'utf-8')
+ const pkg = JSON.parse(content)
+ expect(pkg.name).toBe('my-store')
+ })
+
+ it('does not create storefront directory in backend-only mode', async () => {
+ const projectDir = getTempProjectDir()
+
+ await scaffold({
+ directory: projectDir,
+ mode: 'backend-only',
+ sampleData: false,
+ start: false,
+ packageManager: 'npm',
+ })
+
+ expect(fs.existsSync(path.join(projectDir, 'apps'))).toBe(false)
+ })
+
+ it('rejects non-empty directory', async () => {
+ const projectDir = getTempProjectDir()
+ fs.mkdirSync(projectDir, { recursive: true })
+ fs.writeFileSync(path.join(projectDir, 'existing-file'), 'content')
+
+ // scaffold calls process.exit(1) for non-empty dirs, so we mock it
+ const mockExit = vi.spyOn(process, 'exit').mockImplementation(() => {
+ throw new Error('process.exit called')
+ })
+
+ await expect(
+ scaffold({
+ directory: projectDir,
+ mode: 'backend-only',
+ sampleData: false,
+ start: false,
+ packageManager: 'npm',
+ })
+ ).rejects.toThrow('process.exit called')
+
+ mockExit.mockRestore()
+ })
+})
diff --git a/packages/create-spree-app/tests/templates.test.ts b/packages/create-spree-app/tests/templates.test.ts
new file mode 100644
index 0000000000..4e59e77e99
--- /dev/null
+++ b/packages/create-spree-app/tests/templates.test.ts
@@ -0,0 +1,119 @@
+import { describe, it, expect } from 'vitest'
+import { dockerComposeContent } from '../src/templates/docker-compose'
+import { envContent, storefrontEnvContent } from '../src/templates/env'
+import { rootPackageJsonContent } from '../src/templates/package-json'
+import { readmeContent } from '../src/templates/readme'
+import { gitignoreContent } from '../src/templates/gitignore'
+
+describe('dockerComposeContent', () => {
+ const content = dockerComposeContent()
+
+ it('includes the Spree image', () => {
+ expect(content).toContain('ghcr.io/spree/spree')
+ })
+
+ it('includes postgres service', () => {
+ expect(content).toContain('postgres:17-alpine')
+ })
+
+ it('includes healthcheck for spree', () => {
+ expect(content).toContain('curl -f http://localhost:3000/up')
+ })
+
+ it('includes volume definition', () => {
+ expect(content).toContain('postgres_data:')
+ })
+
+ it('uses env var for SECRET_KEY_BASE', () => {
+ expect(content).toContain('${SECRET_KEY_BASE}')
+ })
+})
+
+describe('envContent', () => {
+ it('includes the provided secret key', () => {
+ const content = envContent('my-secret-123')
+ expect(content).toContain('SECRET_KEY_BASE=my-secret-123')
+ })
+
+ it('includes SPREE_VERSION_TAG', () => {
+ const content = envContent('any')
+ expect(content).toContain('SPREE_VERSION_TAG=')
+ })
+})
+
+describe('storefrontEnvContent', () => {
+ it('includes placeholder when no key provided', () => {
+ const content = storefrontEnvContent()
+ expect(content).toContain('pk_REPLACE_ME_AFTER_DOCKER_START')
+ })
+
+ it('includes real key when provided', () => {
+ const content = storefrontEnvContent('pk_test123')
+ expect(content).toContain('NEXT_PUBLIC_SPREE_PUBLISHABLE_KEY=pk_test123')
+ })
+
+ it('includes API URL', () => {
+ const content = storefrontEnvContent()
+ expect(content).toContain('NEXT_PUBLIC_SPREE_API_URL=http://localhost:3000')
+ })
+})
+
+describe('rootPackageJsonContent', () => {
+ it('returns valid JSON', () => {
+ const content = rootPackageJsonContent('my-store')
+ expect(() => JSON.parse(content)).not.toThrow()
+ })
+
+ it('sets the project name', () => {
+ const pkg = JSON.parse(rootPackageJsonContent('my-store'))
+ expect(pkg.name).toBe('my-store')
+ })
+
+ it('includes convenience scripts', () => {
+ const pkg = JSON.parse(rootPackageJsonContent('my-store'))
+ expect(pkg.scripts.dev).toContain('docker compose')
+ expect(pkg.scripts.down).toContain('docker compose')
+ expect(pkg.scripts.logs).toContain('docker compose')
+ })
+
+ it('is marked private', () => {
+ const pkg = JSON.parse(rootPackageJsonContent('my-store'))
+ expect(pkg.private).toBe(true)
+ })
+})
+
+describe('readmeContent', () => {
+ it('includes the project name as heading', () => {
+ const content = readmeContent('my-store', false)
+ expect(content).toContain('# my-store')
+ })
+
+ it('includes admin credentials', () => {
+ const content = readmeContent('my-store', false)
+ expect(content).toContain('[email protected]')
+ expect(content).toContain('spree123')
+ })
+
+ it('includes storefront section when full-stack', () => {
+ const content = readmeContent('my-store', true)
+ expect(content).toContain('storefront')
+ expect(content).toContain('npm run dev')
+ })
+
+ it('omits storefront section when backend-only', () => {
+ const content = readmeContent('my-store', false)
+ expect(content).not.toContain('Start the storefront')
+ })
+})
+
+describe('gitignoreContent', () => {
+ const content = gitignoreContent()
+
+ it('ignores node_modules', () => {
+ expect(content).toContain('node_modules')
+ })
+
+ it('ignores .env', () => {
+ expect(content).toContain('.env')
+ })
+})
diff --git a/packages/create-spree-app/tests/utils.test.ts b/packages/create-spree-app/tests/utils.test.ts
new file mode 100644
index 0000000000..e04534c569
--- /dev/null
+++ b/packages/create-spree-app/tests/utils.test.ts
@@ -0,0 +1,71 @@
+import { describe, it, expect, beforeEach } from 'vitest'
+import { detectPackageManager, generateSecretKeyBase, installCommand, runCommand } from '../src/utils'
+
+describe('detectPackageManager', () => {
+ const originalEnv = process.env.npm_config_user_agent
+
+ beforeEach(() => {
+ process.env.npm_config_user_agent = originalEnv
+ })
+
+ it('detects yarn', () => {
+ process.env.npm_config_user_agent = 'yarn/1.22.0 npm/? node/v20.0.0'
+ expect(detectPackageManager()).toBe('yarn')
+ })
+
+ it('detects pnpm', () => {
+ process.env.npm_config_user_agent = 'pnpm/8.0.0 npm/? node/v20.0.0'
+ expect(detectPackageManager()).toBe('pnpm')
+ })
+
+ it('defaults to npm', () => {
+ process.env.npm_config_user_agent = 'npm/10.0.0 node/v20.0.0'
+ expect(detectPackageManager()).toBe('npm')
+ })
+
+ it('defaults to npm when env var is missing', () => {
+ delete process.env.npm_config_user_agent
+ expect(detectPackageManager()).toBe('npm')
+ })
+})
+
+describe('generateSecretKeyBase', () => {
+ it('returns a 128-character hex string', () => {
+ const key = generateSecretKeyBase()
+ expect(key).toMatch(/^[0-9a-f]{128}$/)
+ })
+
+ it('generates unique values', () => {
+ const key1 = generateSecretKeyBase()
+ const key2 = generateSecretKeyBase()
+ expect(key1).not.toBe(key2)
+ })
+})
+
+describe('installCommand', () => {
+ it('returns "npm install" for npm', () => {
+ expect(installCommand('npm')).toBe('npm install')
+ })
+
+ it('returns "yarn" for yarn', () => {
+ expect(installCommand('yarn')).toBe('yarn')
+ })
+
+ it('returns "pnpm install" for pnpm', () => {
+ expect(installCommand('pnpm')).toBe('pnpm install')
+ })
+})
+
+describe('runCommand', () => {
+ it('returns "npx" for npm', () => {
+ expect(runCommand('npm')).toBe('npx')
+ })
+
+ it('returns "yarn" for yarn', () => {
+ expect(runCommand('yarn')).toBe('yarn')
+ })
+
+ it('returns "pnpm" for pnpm', () => {
+ expect(runCommand('pnpm')).toBe('pnpm')
+ })
+})
diff --git a/packages/create-spree-app/tsconfig.json b/packages/create-spree-app/tsconfig.json
new file mode 100644
index 0000000000..d481b76829
--- /dev/null
+++ b/packages/create-spree-app/tsconfig.json
@@ -0,0 +1,21 @@
+{
+ "compilerOptions": {
+ "target": "ES2022",
+ "module": "ESNext",
+ "moduleResolution": "bundler",
+ "lib": ["ES2022"],
+ "strict": true,
+ "esModuleInterop": true,
+ "skipLibCheck": true,
+ "forceConsistentCasingInFileNames": true,
+ "outDir": "./dist",
+ "rootDir": "./src",
+ "resolveJsonModule": true,
+ "noUnusedLocals": true,
+ "noUnusedParameters": true,
+ "noImplicitReturns": true,
+ "noFallthroughCasesInSwitch": true
+ },
+ "include": ["src/**/*"],
+ "exclude": ["node_modules", "dist"]
+}
diff --git a/packages/create-spree-app/tsup.config.ts b/packages/create-spree-app/tsup.config.ts
new file mode 100644
index 0000000000..0fa8c006d6
--- /dev/null
+++ b/packages/create-spree-app/tsup.config.ts
@@ -0,0 +1,19 @@
+import { defineConfig } from 'tsup'
+
+export default defineConfig({
+ entry: ['src/index.ts'],
+ format: ['esm'],
+ target: 'node20',
+ platform: 'node',
+ noExternal: [/.*/],
+ splitting: false,
+ clean: true,
+ minify: true,
+ banner: {
+ js: [
+ '#!/usr/bin/env node',
+ 'import { createRequire as __createRequire } from "node:module";',
+ 'const require = __createRequire(import.meta.url);',
+ ].join('\n'),
+ },
+})
diff --git a/packages/create-spree-app/vitest.config.ts b/packages/create-spree-app/vitest.config.ts
new file mode 100644
index 0000000000..9eef0e8a80
--- /dev/null
+++ b/packages/create-spree-app/vitest.config.ts
@@ -0,0 +1,8 @@
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+ test: {
+ environment: 'node',
+ include: ['tests/**/*.test.ts'],
+ },
+})
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 9df6dbba49..ebbd586579 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -12,6 +12,37 @@ importers:
specifier: ^2.5.0
version: 2.8.3
+ packages/create-spree-app:
+ dependencies:
+ '@clack/prompts':
+ specifier: ^0.10.0
+ version: 0.10.1
+ commander:
+ specifier: ^13.1.0
+ version: 13.1.0
+ execa:
+ specifier: ^9.5.2
+ version: 9.6.1
+ giget:
+ specifier: ^2.0.0
+ version: 2.0.0
+ picocolors:
+ specifier: ^1.1.1
+ version: 1.1.1
+ devDependencies:
+ '@types/node':
+ specifier: ^20.0.0
+ version: 20.19.33
+ tsup:
+ specifier: ^8.0.0
+ typescript:
+ specifier: ^5.3.0
+ version: 5.9.3
+ vitest:
+ specifier: ^4.0.18
+
packages/next:
devDependencies:
'@changesets/changelog-github':
@@ -166,6 +197,12 @@ packages:
'@changesets/[email protected]':
resolution: {integrity: sha512-CdTLvIOPiCNuH71pyDu3rA+Q0n65cmAbXnwWH84rKGiFumFzkmHNT8KHTMEchcxN+Kl8I54xGUhJ7l3E7X396Q==}
+ '@clack/[email protected]':
+ resolution: {integrity: sha512-NYQfcEy8MWIxrT5Fj8nIVchfRFA26yYKJcvBS7WlUIlw2OmQOY9DhGGXMovyI5J5PpxrCPGkgUi207EBrjpBvg==}
+
+ '@clack/[email protected]':
+ resolution: {integrity: sha512-Q0T02vx8ZM9XSv9/Yde0jTmmBQufZhPJfYAg2XrrrxWWaZgq1rr8nU8Hv710BQ1dhoP8rtY7YUdpGej2Qza/cw==}
+
'@emnapi/[email protected]':
resolution: {integrity: sha512-mehfKSMWjjNol8659Z8KxEMrdSJDDot5SXMq00dM8BN4o+CLNXQ0xH2V7EchNHV4RmbZLmmPdEaXZc5H2FXmDg==}
@@ -726,6 +763,13 @@ packages:
cpu: [x64]
os: [win32]
+ '@sec-ant/[email protected]':
+ resolution: {integrity: sha512-831qok9r2t8AlxLko40y2ebgSDhenenCatLVeW/uBtnHPyhHOvG0C7TvfgecV+wHzIm5KUICgzmVpWS+IMEAeg==}
+
+ '@sindresorhus/[email protected]':
+ resolution: {integrity: sha512-tlqY9xq5ukxTUZBmoOp+m61cqwQD5pHJtFY3Mn8CA8ps6yghLH/Hw8UPdqg4OLmFW3IFlcXnQNmo/dh8HzXYIQ==}
+ engines: {node: '>=18'}
+
'@standard-schema/[email protected]':
resolution: {integrity: sha512-l2aFy5jALhniG5HgqrD6jXLi/rUWrKvqN/qJx6yoJsgKhblVd+iqqU4RCXavm/jPityDo5TCvKMnpjKnOriy0w==}
@@ -864,6 +908,12 @@ packages:
resolution: {integrity: sha512-NIxF55hv4nSqQswkAeiOi1r83xy8JldOFDTWiug55KBu9Jnblncd2U6ViHmYgHf01TPZS77NJBhBMKdWj9HQMQ==}
engines: {node: '>=8'}
+ resolution: {integrity: sha512-tskPPKEs8D2KPafUypv2gxwJP8h/OaJmC82QQGGDQcHvXX43xF2VDACcJVmZ0EuSxkpO9Kc4MlrA3q0+FG58AQ==}
+
+ resolution: {integrity: sha512-kEV95lFBhQgtogAPlQfJJ0WGVSokvLr/UEoFPiKKOXF7pl98HfUVUD0ejsuTCld/9xH9vogSywZ5KqHzXrZpqg==}
+
resolution: {integrity: sha512-ouuZd4/dm2Sw5Gmqy6bGyNNNe1qt9RpmxveLSO7KcgsTnU7RXfsw+/bukWGo1abgBiMAic068rclZsO4IWmmxQ==}
engines: {node: '>= 12'}
@@ -882,6 +932,10 @@ packages:
resolution: {integrity: sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==}
+ resolution: {integrity: sha512-/rFeCpNJQbhSZjGVwO9RFV3xPqbnERS8MmIQzCtD/zl6gpJuV/bMLuN92oG3F7d8oDEHHRrujSXNUr8fpjntKw==}
+ engines: {node: '>=18'}
+
resolution: {integrity: sha512-NOKm8xhkzAjzFx8B2v5OAHT+u5pRQc2UCa2Vq9jYL/31o2wi9mxBA7LIFs3sV5VSC49z6pEhfbMULvShKj26WA==}
engines: {node: '>= 6'}
@@ -916,6 +970,9 @@ packages:
supports-color:
optional: true
+ resolution: {integrity: sha512-mEQCMmwJu317oSz8CwdIOdwf3xMif1ttiM8LTufzc3g6kR+9Pe236twL8j3IYT1F7GfRgGcW6MWxzZjLIkuHIg==}
+
resolution: {integrity: sha512-reYkTUJAZb9gUuZ2RvVCNhVHdg62RHnJ7WJl8ftMi4diZ6NWlciOzQN88pUhSELEwflJht4oQDv0F0BMlwaYtA==}
engines: {node: '>=8'}
@@ -959,6 +1016,10 @@ packages:
resolution: {integrity: sha512-7RUKfXgSMMkzt6ZuXmqapOurLGPPfgj6l9uRZ7lRGolvk0y2yocc35LdcxKC5PQZdn2DMqioAQ2NoWcrTKmm6g==}
+ resolution: {integrity: sha512-9Be3ZoN4LmYR90tUoVu2te2BsbzHfhJyfEiAVfz7N5/zv+jduIfLrV2xdQXOHbaD6KgpGdO9PRPM1Y4Q9QkPkA==}
+ engines: {node: ^18.19.0 || >=20.5.0}
+
resolution: {integrity: sha512-knvyeauYhqjOYvQ66MznSMs83wmHrCycNEN6Ao+2AeYEfxUIkuiVxdEa1qlGEPK+We3n0THiDciYSsCcgW/DoA==}
engines: {node: '>=12.0.0'}
@@ -982,6 +1043,10 @@ packages:
picomatch:
optional: true
+ resolution: {integrity: sha512-d+l3qxjSesT4V7v2fh+QnmFnUWv9lSpjarhShNTgBOfA0ttejbQUAlHLitbjkoRiDulW0OPoQPYIGhIC8ohejg==}
+ engines: {node: '>=18'}
+
resolution: {integrity: sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==}
engines: {node: '>=8'}
@@ -1010,9 +1075,17 @@ packages:
resolution: {integrity: sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==}
engines: {node: 6.* || 8.* || >= 10.*}
+ resolution: {integrity: sha512-kVCxPF3vQM/N0B1PmoqVUqgHP+EeVjmZSQn+1oCRPxd2P21P2F19lIgbR3HBosbB1PUhOAoctJnfEn2GbN2eZA==}
+ engines: {node: '>=18'}
+
resolution: {integrity: sha512-shZT/QMiSHc/YBLxxOkMtgSid5HFoauqCE3/exfsEcwg1WkeqjG+V40yBbBrsD+jW2HDXcs28xOfcbm2jI8Ddw==}
+ resolution: {integrity: sha512-L5bGsVkxJbJgdnwyuheIunkGatUF/zssUoxxjACCseZYAVbaqdh9Tsmmlkl8vYan09H7sbvKt4pS8GqKLBrEzA==}
+ hasBin: true
+
resolution: {integrity: sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==}
engines: {node: '>= 6'}
@@ -1042,6 +1115,10 @@ packages:
resolution: {integrity: sha512-tsYlhAYpjCKa//8rXZ9DqKEawhPoSytweBC2eNvcaDK+57RZLHGqNs3PZTQO6yekLFSuvA6AlnAfrw1uBvtb+Q==}
hasBin: true
+ resolution: {integrity: sha512-eKCa6bwnJhvxj14kZk5NCPc6Hb6BdsU9DZcOnmQKSnO1VKrfV0zCvtttPZUsBvjmNDn8rpcJfpwSYnHBjc95MQ==}
+ engines: {node: '>=18.18.0'}
+
resolution: {integrity: sha512-im9DjEDQ55s9fL4EYzOAv0yMqmMBSZp6G0VvFyTMPKWxiSBHUj9NW/qqLmXUwXrrM7AvqSlTCfvqRb0cM8yYqw==}
engines: {node: '>=0.10.0'}
@@ -1069,10 +1146,22 @@ packages:
resolution: {integrity: sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==}
engines: {node: '>=0.12.0'}
+ resolution: {integrity: sha512-+Pgi+vMuUNkJyExiMBt5IlFoMyKnr5zhJ4Uspz58WOhBF5QoIZkFyNHIbBAtHwzVAgk5RtndVNsDRN61/mmDqg==}
+ engines: {node: '>=12'}
+
+ resolution: {integrity: sha512-Dnz92NInDqYckGEUJv689RbRiTSEHCQ7wOVeALbkOz999YpqT46yMRIGtSNl2iCL1waAZSx40+h59NV/EwzV/A==}
+ engines: {node: '>=18'}
+
resolution: {integrity: sha512-2AT6j+gXe/1ueqbW6fLZJiIw3F8iXGJtt0yDrZaBhAZEG1raiTxKWU+IPqMCzQAXOUCKdA4UDMgacKH25XG2Cw==}
engines: {node: '>=4'}
+ resolution: {integrity: sha512-mE00Gnza5EEB3Ds0HfMyllZzbBrmLOX3vfWoj9A9PEnTfratQ/BcaJOuMhnkhjXvb2+FkY3VuHqtAGpTPmglFQ==}
+ engines: {node: '>=18'}
+
resolution: {integrity: sha512-eXK1UInq2bPmjyX6e3VHIzMLobc4J94i4AWn+Hpq3OU5KkrRC96OAcR3PRJ/pGu6m8TRnBHP9dkXQVsT/COVIA==}
engines: {node: '>=0.10.0'}
@@ -1199,6 +1288,9 @@ packages:
sass:
optional: true
+ resolution: {integrity: sha512-g9yhqoedzIUm0nTnTqAQvueMPVOuIY16bqgAJJC8XOOubYFNwz6IER9qs0Gq2Xd0+CecCKFjtdDTMA4u4xG06Q==}
+
resolution: {integrity: sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==}
engines: {node: 4.x || >=6.0.0}
@@ -1208,6 +1300,15 @@ packages:
encoding:
optional: true
+ resolution: {integrity: sha512-9qny7Z9DsQU8Ou39ERsPU4OZQlSTP47ShQzuKZ6PRXpYLtIFgl/DEBYEXKlvcEa+9tHVcK8CF81Y2V72qaZhWA==}
+ engines: {node: '>=18'}
+
+ resolution: {integrity: sha512-K6AJy1GMVyfyMXRVB88700BJqNUkByijGJM8kEHpLdcAt+vSQAVfkWWHYzuRXHSY6xA2sNc5RjTj0p9rE2izVQ==}
+ engines: {node: '>=18'}
+ hasBin: true
+
resolution: {integrity: sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg==}
engines: {node: '>=0.10.0'}
@@ -1244,6 +1345,10 @@ packages:
resolution: {integrity: sha512-BEnLolu+yuz22S56CU1SUKq3XC3PkwD5wv4ikR4MfGvnRVcmzXR9DwSlW2fEamyTPyXHomBJRzgapeuBvRNzJQ==}
+ resolution: {integrity: sha512-TXfryirbmq34y8QBwgqCVLi+8oA3oWx2eAnSn62ITyEhEYaWRlVZ2DvMM9eZbMs/RfxPu/PK/aBLyGj4IrqMHw==}
+ engines: {node: '>=18'}
+
resolution: {integrity: sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==}
engines: {node: '>=8'}
@@ -1252,6 +1357,10 @@ packages:
resolution: {integrity: sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==}
engines: {node: '>=8'}
+ resolution: {integrity: sha512-haREypq7xkM7ErfgIyA0z+Bj4AGKlMSdlQE2jvJo6huWD1EdkKYV+G/T4nq0YEF2vgTT8kqMFKo1uHn950r4SQ==}
+ engines: {node: '>=12'}
+
resolution: {integrity: sha512-Yhpw4T9C6hPpgPeA28us07OJeqZ5EzQTkbfwuhsUg0c237RomFoETJgmp2sa3F/41gfLE6G5cqcYwznmeEeOlQ==}
@@ -1315,6 +1424,10 @@ packages:
engines: {node: '>=10.13.0'}
hasBin: true
+ resolution: {integrity: sha512-gjVS5hOP+M3wMm5nmNOucbIrqudzs9v/57bWRHQWLYklXqoXKrVfYW2W9+glfGsqtPgpiz5WwyEEB+ksXIx3gQ==}
+ engines: {node: '>=18'}
+
resolution: {integrity: sha512-AifT7QEbW9Nri4tAwR5M/uzpBuqfZf+zwaEM/QkzEjj7NBuFD2rBuy0K3dE+8wltbezDV7JMA0WfnCPYRSYbXA==}
@@ -1394,6 +1507,9 @@ packages:
resolution: {integrity: sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw==}
engines: {node: '>=14'}
+ resolution: {integrity: sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg==}
+
resolution: {integrity: sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==}
engines: {node: '>=8'}
@@ -1437,6 +1553,10 @@ packages:
resolution: {integrity: sha512-vavAMRXOgBVNF6nyEEmL3DBK19iRpDcoIwW+swQ+CbGiu7lju6t+JklA1MHweoWtadgt4ISVUsXLyDq34ddcwA==}
engines: {node: '>=4'}
+ resolution: {integrity: sha512-aulFJcD6YK8V1G7iRB5tigAP4TsHBZZrOV8pjV++zdUwmeV8uzbY7yn6h9MswN62adStNZFuCIx4haBnRuMDaw==}
+ engines: {node: '>=18'}
+
resolution: {integrity: sha512-qSVyDTeMotdvQYoHWLNGwRFJHC+i+ZvdBRYosOFgC+Wg1vx4frN2/RG/NA7SYqqvKNLf39P2LSRA2pu6n0XYZA==}
engines: {node: '>= 12.0.0'}
@@ -1593,6 +1713,10 @@ packages:
resolution: {integrity: sha512-iwDZqg0QAGrg9Rav5H4n0M64c3mkR59cJ6wQp+7C4nI0gsmExaedaYLNO44eT4AtBBwjbTiGPMlt2Md0T9H9JQ==}
+ resolution: {integrity: sha512-+QBBXBCvifc56fsbuxZQ6Sic3wqqc3WWaqxs58gvJrcOuN83HGTCwz3oS5phzU9LthRNE9VrJCFCLUgHeeFnfA==}
+ engines: {node: '>=18'}
+
resolution: {integrity: sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg==}
engines: {node: '>= 4.0.0'}
@@ -1714,6 +1838,10 @@ packages:
resolution: {integrity: sha512-U/PBtDf35ff0D8X8D0jfdzHYEPFxAI7jJlxZXwCSez5M3190m+QobIfh+sWDWSHMCWWJN2AWamkegn6vr6YBTw==}
engines: {node: '>=18'}
+ resolution: {integrity: sha512-CzhO+pFNo8ajLM2d2IW/R93ipy99LWjtwblvC1RsoSUMZgyLbYFr221TnSNT7GjGdYui6P459mw9JH/g/zW2ug==}
+ engines: {node: '>=18'}
+
resolution: {integrity: sha512-rftlrkhHZOcjDwkGlnUtZZkvaPHCsDATp4pGpuOOMDaTdDDXF91wuVDJoWoPsKX/3YPQ5fHuF3STjcYyKr+Qhg==}
@@ -1895,6 +2023,17 @@ snapshots:
human-id: 4.1.3
prettier: 2.8.8
+ '@clack/[email protected]':
+ dependencies:
+ picocolors: 1.1.1
+ sisteransi: 1.0.5
+
+ '@clack/[email protected]':
+ dependencies:
+ '@clack/core': 0.4.2
+ picocolors: 1.1.1
+ sisteransi: 1.0.5
+
'@emnapi/[email protected]':
dependencies:
tslib: 2.8.1
@@ -2271,6 +2410,10 @@ snapshots:
'@rollup/[email protected]':
optional: true
+ '@sec-ant/[email protected]': {}
+
+ '@sindresorhus/[email protected]': {}
+
'@standard-schema/[email protected]': {}
@@ -2407,6 +2550,12 @@ snapshots:
+ dependencies:
+ consola: 3.4.2
+
+
@@ -2423,6 +2572,8 @@ snapshots:
+
@@ -2445,6 +2596,8 @@ snapshots:
dependencies:
ms: 2.1.3
+
@@ -2502,6 +2655,21 @@ snapshots:
dependencies:
'@types/estree': 1.0.8
+ dependencies:
+ '@sindresorhus/merge-streams': 4.0.0
+ cross-spawn: 7.0.6
+ figures: 6.1.0
+ get-stream: 9.0.1
+ human-signals: 8.0.1
+ is-plain-obj: 4.1.0
+ is-stream: 4.0.1
+ npm-run-path: 6.0.0
+ pretty-ms: 9.3.0
+ signal-exit: 4.1.0
+ strip-final-newline: 4.0.0
+ yoctocolors: 2.1.2
+
@@ -2522,6 +2690,10 @@ snapshots:
optionalDependencies:
picomatch: 4.0.3
+ dependencies:
+ is-unicode-supported: 2.1.0
+
dependencies:
to-regex-range: 5.0.1
@@ -2554,10 +2726,24 @@ snapshots:
+ dependencies:
+ '@sec-ant/readable-stream': 0.4.1
+ is-stream: 4.0.1
+
dependencies:
resolve-pkg-maps: 1.0.0
+ dependencies:
+ citty: 0.1.6
+ consola: 3.4.2
+ defu: 6.1.4
+ node-fetch-native: 1.6.7
+ nypm: 0.6.5
+ pathe: 2.0.3
+
dependencies:
is-glob: 4.0.3
@@ -2583,6 +2769,8 @@ snapshots:
+
dependencies:
safer-buffer: 2.1.2
@@ -2601,10 +2789,16 @@ snapshots:
+
+
dependencies:
better-path-resolve: 1.0.0
+
@@ -2741,10 +2935,23 @@ snapshots:
- '@babel/core'
- babel-plugin-macros
+
dependencies:
whatwg-url: 5.0.0
+ dependencies:
+ path-key: 4.0.0
+ unicorn-magic: 0.3.0
+
+ dependencies:
+ citty: 0.2.1
+ pathe: 2.0.3
+ tinyexec: 1.0.2
+
@@ -2773,10 +2980,14 @@ snapshots:
dependencies:
quansync: 0.2.11
+
+
@@ -2820,6 +3031,10 @@ snapshots:
+ dependencies:
+ parse-ms: 4.0.0
+
@@ -2933,6 +3148,8 @@ snapshots:
+
@@ -2966,6 +3183,8 @@ snapshots:
+
dependencies:
client-only: 0.0.1
@@ -3104,6 +3323,8 @@ snapshots:
+
@@ -3202,4 +3423,6 @@ snapshots:
+
diff --git a/spree/core/app/services/spree/seeds/all.rb b/spree/core/app/services/spree/seeds/all.rb
index 2a60d0cf2a..c00d4f39c4 100644
--- a/spree/core/app/services/spree/seeds/all.rb
+++ b/spree/core/app/services/spree/seeds/all.rb
@@ -27,6 +27,7 @@ module Spree
# add store resources
PaymentMethods.call
+ ApiKeys.call
end
end
end
diff --git a/spree/core/app/services/spree/seeds/api_keys.rb b/spree/core/app/services/spree/seeds/api_keys.rb
new file mode 100644
index 0000000000..7b843f6db4
--- /dev/null
+++ b/spree/core/app/services/spree/seeds/api_keys.rb
@@ -0,0 +1,16 @@
+module Spree
+ module Seeds
+ class ApiKeys
+ prepend Spree::ServiceModule::Base
+
+ def call
+ store = Spree::Store.default
+ return unless store&.persisted?
+
+ unless store.api_keys.active.publishable.exists?
+ store.api_keys.create!(name: 'Default', key_type: 'publishable')
+ end
+ end
+ end
+ end
+end