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.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Offer the React Dashboard in create-spree-app
Damian Legawiec61b2fd494c1d
diff --git a/CLAUDE.md b/CLAUDE.mdindex e250bb1c7d..9d02e2d889 100644--- a/CLAUDE.md+++ b/CLAUDE.md@@ -39,7 +39,7 @@ Multi-version plans (some phases shipped, some pending):- `6.0-order-routing.md` — Two-tier extension: pluggable `Spree::OrderRouting::Strategy::Base` + STI subclasses of `Spree::OrderRoutingRule`. Phase 1 (5.5) shipped: `Channel`, `OrderRoutingRule`, strategy base + Rules + Reducer + Legacy, `preferred_stock_location_id` + `channel_id` on Order. Phase 2+ (6.0) layers Catalog/Company on top via `6.0-channels-catalogs-b2b.md`.- `6.0-channels-catalogs-b2b.md` — Channel + ProductPublication (replaces StoreProduct) + single-owner Product (`belongs_to :store`) + Publishing card (legacy admin + SPA) + `Channel#default` boolean shipped in 5.5. Channel-level gated storefront access (`storefront_access` enum + channel-owned `guest_checkout`, both with store fallback, enforced in the v3 Store API) targeted for 5.6. Catalog, Company/CompanyLocation/CompanyContact for B2B pending in 6.0. Multi-store catalogs (historic `Product has_many :stores`) move to the `spree_multi_store` extension.- `5.6-6.0-single-store-promotions-payment-methods.md` — Migrate `Spree::Promotion` + `Spree::PaymentMethod` from multi-store (`has_many :stores` via `spree_promotions_stores` / `spree_payment_methods_stores` join tables) to single-owner `belongs_to :store`, mirroring the 5.5 single-owner Product migration. 5.6 (implemented): `store_id` FK + required-store presence via `Spree::SingleStoreResource`, backfill rake task (loud per-record deprecation on shared records), shared `LegacyMultiStoreSupport` deprecation bridge, deletes the `ResourceController` `store_ids=` seam, deprecates `StoreScopedResource`; multi-store sharing moves to the `spree_multi_store` extension (join tables left intact). 6.0 cleanup: enforce `null: false`, drop join tables + bridges. Paired with `6.0-channels-catalogs-b2b.md`.-- `5.6-project-layout-and-dashboard.md` — React Dashboard Developer Preview packaging + `backend/` → `api/` project layout. Implemented: `<Dashboard />` shell export from `@spree/dashboard` (source-only, relative imports only), monorepo-canonical `packages/dashboard-starter` thin host (synced to the `spree/dashboard-starter` template repo on release), `spree add dashboard` (env carries only `VITE_SPREE_API_URL` — never secret keys). Pending: layout rename + `detectApiDir` dual-layout CLI, create-spree-app dashboard phase, `spree upgrade layout`, template sync job.+- `5.6-project-layout-and-dashboard.md` — React Dashboard Developer Preview packaging + `backend/` → `api/` project layout. Implemented: `<Dashboard />` shell export from `@spree/dashboard` (source-only, relative imports only), monorepo-canonical `packages/dashboard-starter` thin host (synced to the `spree/dashboard-starter` template repo on release), `spree add dashboard` + create-spree-app dashboard phase (env carries only `VITE_SPREE_API_URL` — never secret keys). Pending: layout rename + `detectApiDir` dual-layout CLI, `spree upgrade layout`, template sync job.- `5.6-dashboard-typed-plugin-routes.md` — Plugin file routes compiled into the host's TanStack route tree: `spree.dashboard.routes` marker + virtual-route-config composition in `@spree/dashboard/vite`, `createDashboardRouter` + `<Dashboard router>` ownership inversion, typed cast-free links, cross-package collision pre-flight with package-named errors. Runtime route registry stays for dynamic/in-app cases (catch-all is lowest priority). Implemented; published-tarball spike passed.Pending design work (drafts, no implementation yet):diff --git a/docs/plans/5.6-project-layout-and-dashboard.md b/docs/plans/5.6-project-layout-and-dashboard.mdindex c73799549a..7d050a5268 100644--- a/docs/plans/5.6-project-layout-and-dashboard.md+++ b/docs/plans/5.6-project-layout-and-dashboard.md@@ -183,7 +183,7 @@ npx create-spree-app my-shop \Defaults: dashboard included unless `--no-dashboard`. Matches the storefront default behavior.-**New scaffolding phases (after backend, before storefront):**+**New scaffolding phase (runs after the optional storefront phase):**```typescript// scaffold.ts (excerpt — new phase 2b: dashboard)@@ -485,12 +485,12 @@ All phases ship in **5.6**. The dashboard ships as Developer Preview alongside `3. Update README of `create-spree-app` package itself.4. Add changeset (minor bump — output layout changes, but no API/import contract is broken; existing CLI install continues to work against either layout).-### Phase 5: Add dashboard scaffolding to create-spree-app+### Phase 5: Add dashboard scaffolding to create-spree-app *(implemented)*1. Implement `src/dashboard.ts` mirroring `src/storefront.ts`.2. Add prompt + flag in `src/prompts.ts` and `src/index.ts`.-3. Update `src/scaffold.ts` to invoke dashboard phase after api, before storefront.-4. Update README template with Dashboard section.+3. Update `src/scaffold.ts` to invoke the dashboard phase after the storefront phase.+4. Update README, CLAUDE.md, and Dependabot templates with Dashboard sections.5. Update tests.### Phase 6: Add `spree add` and `spree upgrade` commands to CLI *(add dashboard implemented)*diff --git a/packages/cli/.changeset/add-dashboard-and-plugin-scaffold.md b/packages/cli/.changeset/add-dashboard-and-plugin-scaffold.mdnew file mode 100644index 0000000000..910d12f43a--- /dev/null+++ b/packages/cli/.changeset/add-dashboard-and-plugin-scaffold.md@@ -0,0 +1,10 @@+---+'@spree/cli': minor+---++Add `spree add dashboard` — clones the React Dashboard starter (Developer+Preview) into `apps/dashboard/` of an existing project and points it at the+project's API. Also make `spree plugin new` fully non-interactive: every prompt+has a flag (`--ruby-name`, `--module-name`, `--npm-scope`, `--author`,+`--author-email`, `--license`, `-y`), with author details defaulting from git+config.diff --git a/packages/cli/src/commands/add.ts b/packages/cli/src/commands/add.tsindex 6c78e58af5..40a877bffe 100644--- a/packages/cli/src/commands/add.ts+++ b/packages/cli/src/commands/add.ts@@ -119,7 +119,7 @@ async function fetchTemplate(template: string, dst: string): Promise<void> {return}- await execa('git', ['clone', '--depth', '1', template, dst])+ await execa('git', ['clone', '--depth', '1', '--', template, dst])fs.rmSync(path.join(dst, '.git'), { recursive: true, force: true })}diff --git a/packages/create-spree-app/.changeset/dashboard-scaffold-phase.md b/packages/create-spree-app/.changeset/dashboard-scaffold-phase.mdnew file mode 100644index 0000000000..377c2dbfe5--- /dev/null+++ b/packages/create-spree-app/.changeset/dashboard-scaffold-phase.md@@ -0,0 +1,8 @@+---+'create-spree-app': minor+---++Offer the React Dashboard (Developer Preview) as an optional component: a new+prompt (and `--no-dashboard` flag) clones the dashboard starter into+`apps/dashboard/`, writes its `.env.local` (API URL only — never credentials),+installs dependencies, and wires the README, CLAUDE.md, and Dependabot config.diff --git a/packages/create-spree-app/src/constants.ts b/packages/create-spree-app/src/constants.tsindex 348b657b20..0ff8bc0796 100644--- a/packages/create-spree-app/src/constants.ts+++ b/packages/create-spree-app/src/constants.ts@@ -1,8 +1,12 @@export const DEFAULT_SPREE_PORT = 3000export const STOREFRONT_PORT = 3001+export const DASHBOARD_PORT = 5173export const STOREFRONT_REPO = 'https://github.com/spree/storefront.git'export const BACKEND_REPO = 'https://github.com/spree/spree-starter.git'+// Canonical source lives at packages/dashboard-starter in the spree/spree+// monorepo; a release job syncs it out with published package versions.+export const DASHBOARD_REPO = 'https://github.com/spree/dashboard-starter.git'export const DEFAULT_ADMIN_EMAIL = '[email protected]'export const DEFAULT_ADMIN_PASSWORD = 'spree123'diff --git a/packages/create-spree-app/src/dashboard.ts b/packages/create-spree-app/src/dashboard.tsnew file mode 100644index 0000000000..ee211057b1--- /dev/null+++ b/packages/create-spree-app/src/dashboard.ts@@ -0,0 +1,26 @@+import fs from 'node:fs'+import path from 'node:path'+import { execa } from 'execa'+import { DASHBOARD_REPO } from './constants.js'+import { dashboardEnvContent } from './templates/env.js'+import type { PackageManager } from './types.js'+import { installCommand } from './utils.js'++export async function downloadDashboard(projectDir: string): Promise<void> {+ const dashboardDir = path.join(projectDir, 'apps', 'dashboard')+ await execa('git', ['clone', '--depth', '1', '--', DASHBOARD_REPO, dashboardDir], {+ stdio: 'ignore',+ })+ fs.rmSync(path.join(dashboardDir, '.git'), { recursive: true, force: true })+}++export async function installDashboardDeps(projectDir: string, pm: PackageManager): Promise<void> {+ const dashboardDir = path.join(projectDir, 'apps', 'dashboard')+ const [cmd, ...args] = installCommand(pm).split(' ')+ await execa(cmd, args, { cwd: dashboardDir, stdio: 'ignore' })+}++export function writeDashboardEnv(projectDir: string, port: number): void {+ const envPath = path.join(projectDir, 'apps', 'dashboard', '.env.local')+ fs.writeFileSync(envPath, dashboardEnvContent(port))+}diff --git a/packages/create-spree-app/src/index.ts b/packages/create-spree-app/src/index.tsindex 9b3cb9bae8..bd6e6ff4d0 100644--- a/packages/create-spree-app/src/index.ts+++ b/packages/create-spree-app/src/index.ts@@ -13,6 +13,7 @@ const program = new Command().description('Create a new Spree Commerce project').argument('[directory]', 'project directory').option('--no-storefront', 'skip Next.js storefront setup')+ .option('--no-dashboard', 'skip React Dashboard setup (Developer Preview)').option('--no-sample-data', 'skip loading sample data').option('--no-start', 'do not start Docker services').option('--port <number>', 'port for the Spree backend', String(DEFAULT_SPREE_PORT))@@ -31,6 +32,7 @@ const program = new Command()const options = await runPrompts({directory,noStorefront: flags.storefront === false ? true : undefined,+ noDashboard: flags.dashboard === false ? true : undefined,noSampleData: flags.sampleData === false ? true : undefined,noStart: flags.start === false ? true : undefined,packageManager,diff --git a/packages/create-spree-app/src/prompts.ts b/packages/create-spree-app/src/prompts.tsindex c671487cd1..1b0459f7a2 100644--- a/packages/create-spree-app/src/prompts.ts+++ b/packages/create-spree-app/src/prompts.ts@@ -4,6 +4,7 @@ import type { PackageManager, ScaffoldOptions } from './types.js'interface PromptFlags {directory?: stringnoStorefront?: boolean+ noDashboard?: booleannoSampleData?: booleannoStart?: booleanpackageManager?: PackageManager@@ -43,6 +44,22 @@ export async function runPrompts(flags: PromptFlags): Promise<Omit<ScaffoldOptiostorefront = storefrontResult}+ let dashboard: boolean+ if (flags.noDashboard !== undefined) {+ dashboard = !flags.noDashboard+ } else {+ const dashboardResult = await p.confirm({+ message: 'Include React Dashboard? (Developer Preview of the next-gen admin)',+ initialValue: true,+ })++ if (p.isCancel(dashboardResult)) {+ p.cancel('Setup cancelled.')+ process.exit(0)+ }+ dashboard = dashboardResult+ }+let sampleData: booleanif (flags.noSampleData !== undefined) {sampleData = !flags.noSampleData@@ -78,6 +95,7 @@ export async function runPrompts(flags: PromptFlags): Promise<Omit<ScaffoldOptioreturn {directory,storefront,+ dashboard,sampleData,start,packageManager: flags.packageManager ?? 'npm',diff --git a/packages/create-spree-app/src/scaffold.ts b/packages/create-spree-app/src/scaffold.tsindex 6992b7da53..7c3c3c9f6a 100644--- a/packages/create-spree-app/src/scaffold.ts+++ b/packages/create-spree-app/src/scaffold.ts@@ -4,7 +4,8 @@ import * as p from '@clack/prompts'import { execa } from 'execa'import pc from 'picocolors'import { downloadBackend } from './backend.js'-import { DEFAULT_ADMIN_EMAIL, DEFAULT_ADMIN_PASSWORD } from './constants.js'+import { DASHBOARD_PORT, DEFAULT_ADMIN_EMAIL, DEFAULT_ADMIN_PASSWORD } from './constants.js'+import { downloadDashboard, installDashboardDeps, writeDashboardEnv } from './dashboard.js'import {downloadStorefront,installRootDeps,@@ -23,7 +24,7 @@ import { generateSecretKeyBase, isDockerRunning } from './utils.js'export async function scaffold(options: ScaffoldOptions): Promise<void> {const projectDir = path.resolve(options.directory)const projectName = path.basename(projectDir)- const { port, storefront } = options+ const { port, storefront, dashboard } = options// Pre-flight checksif (options.start) {@@ -79,14 +80,17 @@ export async function scaffold(options: ScaffoldOptions): Promise<void> {fs.writeFileSync(path.join(projectDir, '.env'), envContent(generateSecretKeyBase(), port))fs.writeFileSync(path.join(projectDir, 'package.json'), rootPackageJsonContent(projectName))- fs.writeFileSync(path.join(projectDir, 'README.md'), readmeContent(projectName, storefront, port))+ fs.writeFileSync(+ path.join(projectDir, 'README.md'),+ readmeContent(projectName, storefront, port, dashboard),+ )fs.writeFileSync(path.join(projectDir, '.gitignore'), gitignoreContent())- fs.writeFileSync(path.join(projectDir, 'CLAUDE.md'), rootClaudeMdContent(storefront))+ fs.writeFileSync(path.join(projectDir, 'CLAUDE.md'), rootClaudeMdContent(storefront, dashboard))fs.writeFileSync(path.join(projectDir, 'AGENTS.md'), agentsMdContent())const githubDir = path.join(projectDir, '.github')fs.mkdirSync(githubDir, { recursive: true })- fs.writeFileSync(path.join(githubDir, 'dependabot.yml'), dependabotContent(storefront))+ fs.writeFileSync(path.join(githubDir, 'dependabot.yml'), dependabotContent(storefront, dashboard))s.stop('Project structure created.')@@ -108,6 +112,19 @@ export async function scaffold(options: ScaffoldOptions): Promise<void> {s.stop('Storefront dependencies installed.')}+ // Phase 3b: React Dashboard (optional, Developer Preview)+ if (dashboard) {+ s.start('Downloading dashboard starter...')+ await downloadDashboard(projectDir)+ s.stop('Dashboard starter downloaded.')++ writeDashboardEnv(projectDir, port)++ s.start('Installing dashboard dependencies...')+ await installDashboardDeps(projectDir, options.packageManager)+ s.stop('Dashboard dependencies installed.')+ }+// Phase 4: Initialize and start servicesif (options.start) {const initArgs = ['spree', 'init']@@ -123,14 +140,20 @@ export async function scaffold(options: ScaffoldOptions): Promise<void> {`${pc.bold('Storefront')}: ${pc.cyan(`cd ${projectName}/apps/storefront && npm run dev`)}`,)}+ if (dashboard) {+ p.log.info(+ `${pc.bold('React Dashboard')}: ${pc.cyan(`cd ${projectName}/apps/dashboard && npm run dev`)} → http://localhost:${DASHBOARD_PORT}`,+ )+ }} else {- printSuccessWithoutDocker(projectName, storefront, port)+ printSuccessWithoutDocker(projectName, storefront, dashboard, port)}}function printSuccessWithoutDocker(projectName: string,hasStorefront: boolean,+ hasDashboard: boolean,port: number,): void {const lines: string[] = [@@ -150,6 +173,16 @@ function printSuccessWithoutDocker()}+ if (hasDashboard) {+ lines.push(+ '',+ ` ${pc.dim('# React Dashboard (Developer Preview), in another terminal:')}`,+ ` cd ${projectName}/apps/dashboard`,+ ` npm install`,+ ` npm run dev`,+ )+ }+lines.push('',`${pc.bold('Admin Dashboard')}`,diff --git a/packages/create-spree-app/src/templates/claude-md.ts b/packages/create-spree-app/src/templates/claude-md.tsindex 1290fef54c..82b305ebf2 100644--- a/packages/create-spree-app/src/templates/claude-md.ts+++ b/packages/create-spree-app/src/templates/claude-md.ts@@ -19,7 +19,7 @@ full skill list.`}-export function rootClaudeMdContent(hasStorefront: boolean): string {+export function rootClaudeMdContent(hasStorefront: boolean, hasDashboard = false): string {const lines = ['# Spree Commerce Application','',@@ -34,6 +34,10 @@ export function rootClaudeMdContent(hasStorefront: boolean): string {lines.push('| `apps/storefront/` | Next.js storefront |')}+ if (hasDashboard) {+ lines.push('| `apps/dashboard/` | React Dashboard — admin SPA (Developer Preview) |')+ }+lines.push('','## Agent Instructions',@@ -47,6 +51,13 @@ export function rootClaudeMdContent(hasStorefront: boolean): string {)}+ if (hasDashboard) {+ lines.push(+ '- **React Dashboard work** (admin SPA, React, TypeScript): See `apps/dashboard/README.md`',+ ' and https://spreecommerce.org/docs/developer/dashboard/overview',+ )+ }+lines.push('','## Spree Documentation',diff --git a/packages/create-spree-app/src/templates/dependabot.ts b/packages/create-spree-app/src/templates/dependabot.tsindex 48f41a9925..542fd392f5 100644--- a/packages/create-spree-app/src/templates/dependabot.ts+++ b/packages/create-spree-app/src/templates/dependabot.ts@@ -40,7 +40,7 @@ function ecosystemBlock({ comment, ecosystem, directory, group }: Ecosystem): st* toggle in the repo's Settings → Advanced Security; the config only groups* them.*/-export function dependabotContent(hasStorefront: boolean): string {+export function dependabotContent(hasStorefront: boolean, hasDashboard = false): string {const ecosystems: Ecosystem[] = [{comment: 'Root wrapper (@spree/cli, @spree/docs)',@@ -71,6 +71,15 @@ export function dependabotContent(hasStorefront: boolean): string {})}+ if (hasDashboard) {+ ecosystems.push({+ comment: 'React Dashboard (Developer Preview)',+ ecosystem: 'npm',+ directory: '/apps/dashboard',+ group: 'dashboard',+ })+ }+return `version: 2updates:${ecosystems.map(ecosystemBlock).join('\n\n')}diff --git a/packages/create-spree-app/src/templates/env.ts b/packages/create-spree-app/src/templates/env.tsindex c470cf5ca1..ded88322b0 100644--- a/packages/create-spree-app/src/templates/env.ts+++ b/packages/create-spree-app/src/templates/env.ts@@ -10,3 +10,10 @@ export function storefrontEnvContent(port: number, apiKey?: string): string {SPREE_PUBLISHABLE_KEY=${apiKey ?? 'pk_REPLACE_ME_AFTER_DOCKER_START'}`}++export function dashboardEnvContent(port: number): string {+ return `# URL of your Spree API server. No credentials belong in this file —+# every VITE_-prefixed value is compiled into the client bundle.+VITE_SPREE_API_URL=http://localhost:${port}+`+}diff --git a/packages/create-spree-app/src/templates/readme.ts b/packages/create-spree-app/src/templates/readme.tsindex accd334be9..72bfce1c5f 100644--- a/packages/create-spree-app/src/templates/readme.ts+++ b/packages/create-spree-app/src/templates/readme.ts@@ -1,6 +1,16 @@-import { DEFAULT_ADMIN_EMAIL, DEFAULT_ADMIN_PASSWORD, STOREFRONT_PORT } from '../constants.js'--export function readmeContent(name: string, hasStorefront: boolean, port: number): string {+import {+ DASHBOARD_PORT,+ DEFAULT_ADMIN_EMAIL,+ DEFAULT_ADMIN_PASSWORD,+ STOREFRONT_PORT,+} from '../constants.js'++export function readmeContent(+ name: string,+ hasStorefront: boolean,+ port: number,+ hasDashboard = false,+): string {let content = `# ${name}A [Spree Commerce](https://spreecommerce.org) project.@@ -41,6 +51,29 @@ Open http://localhost:${STOREFRONT_PORT}`}+ if (hasDashboard) {+ content += `+### Start the React Dashboard (Developer Preview)++The React Dashboard in \`apps/dashboard/\` is the next generation of the Spree+admin — a customizable React SPA you can extend with your own pages and+plugins. It's a Developer Preview: the classic admin at+http://localhost:${port}/admin remains the stable default.++Dependencies are already installed during setup — just start it:++\`\`\`bash+cd apps/dashboard+npm run dev+\`\`\`++Open http://localhost:${DASHBOARD_PORT} and sign in with the admin email and password above.++To learn how to add pages, tweak tables, or build plugins, see the+[React Dashboard docs](https://spreecommerce.org/docs/developer/dashboard/overview).+`+ }+content += `## Customizing the Backenddiff --git a/packages/create-spree-app/src/types.ts b/packages/create-spree-app/src/types.tsindex c5e3b09b61..b4b87486e9 100644--- a/packages/create-spree-app/src/types.ts+++ b/packages/create-spree-app/src/types.ts@@ -3,6 +3,7 @@ export type PackageManager = 'npm' | 'yarn' | 'pnpm'export interface ScaffoldOptions {directory: stringstorefront: boolean+ dashboard: booleansampleData: booleanstart: booleanpackageManager: PackageManagerdiff --git a/packages/create-spree-app/tests/scaffold.test.ts b/packages/create-spree-app/tests/scaffold.test.tsindex 8c77df0b07..4a6e153c82 100644--- a/packages/create-spree-app/tests/scaffold.test.ts+++ b/packages/create-spree-app/tests/scaffold.test.ts@@ -69,6 +69,19 @@ vi.mock('../src/storefront', async (importOriginal) => {}})+vi.mock('../src/dashboard', async (importOriginal) => {+ const mod = await importOriginal<typeof import('../src/dashboard')>()+ return {+ ...mod,+ // Simulate the clone so the real writeDashboardEnv has a directory to+ // write into.+ downloadDashboard: vi.fn(async (projectDir: string) => {+ fs.mkdirSync(path.join(projectDir, 'apps', 'dashboard'), { recursive: true })+ }),+ installDashboardDeps: vi.fn(),+ }+})+vi.mock('../src/backend', () => ({downloadBackend: vi.fn(async (projectDir: string) => {// Simulate what downloadBackend does: create backend/ with compose files@@ -106,6 +119,7 @@ describe('scaffold (no-start)', () => {await scaffold({directory: projectDir,storefront: true,+ dashboard: false,sampleData: false,start: false,packageManager: 'npm',@@ -126,6 +140,7 @@ describe('scaffold (no-start)', () => {await scaffold({directory: projectDir,storefront: true,+ dashboard: false,sampleData: false,start: false,packageManager: 'npm',@@ -143,6 +158,7 @@ describe('scaffold (no-start)', () => {await scaffold({directory: projectDir,storefront: true,+ dashboard: false,sampleData: false,start: false,packageManager: 'npm',@@ -160,6 +176,7 @@ describe('scaffold (no-start)', () => {await scaffold({directory: projectDir,storefront: true,+ dashboard: false,sampleData: false,start: false,packageManager: 'npm',@@ -179,6 +196,7 @@ describe('scaffold (no-start)', () => {await scaffold({directory: projectDir,storefront: true,+ dashboard: false,sampleData: false,start: false,packageManager: 'npm',@@ -196,6 +214,7 @@ describe('scaffold (no-start)', () => {await scaffold({directory: projectDir,storefront: true,+ dashboard: false,sampleData: false,start: false,packageManager: 'npm',@@ -208,6 +227,46 @@ describe('scaffold (no-start)', () => {expect(pkg.scripts.eject).toBe('spree eject')})+ it('writes the dashboard env when the dashboard is included', async () => {+ const projectDir = getTempProjectDir()++ await scaffold({+ directory: projectDir,+ storefront: false,+ dashboard: true,+ sampleData: false,+ start: false,+ packageManager: 'npm',+ port: 4567,+ })++ const envPath = path.join(projectDir, 'apps', 'dashboard', '.env.local')+ const env = fs.readFileSync(envPath, 'utf-8')+ expect(env).toContain('VITE_SPREE_API_URL=http://localhost:4567')+ expect(fs.readFileSync(path.join(projectDir, 'README.md'), 'utf-8')).toContain(+ 'React Dashboard',+ )+ })++ it('skips the dashboard by default', async () => {+ const projectDir = getTempProjectDir()++ await scaffold({+ directory: projectDir,+ storefront: false,+ dashboard: false,+ sampleData: false,+ start: false,+ packageManager: 'npm',+ port: 3000,+ })++ expect(fs.existsSync(path.join(projectDir, 'apps', 'dashboard'))).toBe(false)+ expect(fs.readFileSync(path.join(projectDir, 'README.md'), 'utf-8')).not.toContain(+ 'React Dashboard',+ )+ })+it('rejects non-empty directory', async () => {const projectDir = getTempProjectDir()fs.mkdirSync(projectDir, { recursive: true })diff --git a/packages/create-spree-app/tests/templates.test.ts b/packages/create-spree-app/tests/templates.test.tsindex 44505ab770..de3a37b036 100644--- a/packages/create-spree-app/tests/templates.test.ts+++ b/packages/create-spree-app/tests/templates.test.ts@@ -1,6 +1,7 @@import { describe, expect, it } from 'vitest'+import { rootClaudeMdContent } from '../src/templates/claude-md'import { dependabotContent } from '../src/templates/dependabot'-import { envContent, storefrontEnvContent } from '../src/templates/env'+import { dashboardEnvContent, envContent, storefrontEnvContent } from '../src/templates/env'import { gitignoreContent } from '../src/templates/gitignore'import { rootPackageJsonContent } from '../src/templates/package-json'import { readmeContent } from '../src/templates/readme'@@ -44,6 +45,17 @@ describe('storefrontEnvContent', () => {})})+describe('dashboardEnvContent', () => {+ it('points VITE_SPREE_API_URL at the given port', () => {+ expect(dashboardEnvContent(4567)).toContain('VITE_SPREE_API_URL=http://localhost:4567')+ })++ it('contains no credentials — VITE_ values ship to every browser', () => {+ const content = dashboardEnvContent(3000)+ expect(content).not.toMatch(/pk_|sk_|KEY=(?!http)/)+ })+})+describe('rootPackageJsonContent', () => {it('returns valid JSON', () => {const content = rootPackageJsonContent('my-store')@@ -132,6 +144,30 @@ describe('readmeContent', () => {expect(content).toContain('.spree/credentials.json')expect(content).toContain('npm install -g @spree/cli')})++ it('includes the React Dashboard section when included', () => {+ const content = readmeContent('my-store', true, 3000, true)+ expect(content).toContain('### Start the React Dashboard (Developer Preview)')+ expect(content).toContain('http://localhost:5173')+ expect(content).toContain('docs/developer/dashboard')+ })++ it('omits the React Dashboard section by default', () => {+ const content = readmeContent('my-store', true, 3000)+ expect(content).not.toContain('React Dashboard')+ })+})++describe('rootClaudeMdContent', () => {+ it('lists apps/dashboard when the dashboard is included', () => {+ const content = rootClaudeMdContent(true, true)+ expect(content).toContain('`apps/dashboard/`')+ expect(content).toContain('docs/developer/dashboard')+ })++ it('omits apps/dashboard by default', () => {+ expect(rootClaudeMdContent(true)).not.toContain('apps/dashboard')+ })})describe('gitignoreContent', () => {@@ -170,6 +206,16 @@ describe('dependabotContent', () => {expect(content).toContain('package-ecosystem: npm\n directory: "/apps/storefront"')})+ it('adds the dashboard npm ecosystem when the dashboard is included', () => {+ const content = dependabotContent(true, true)+ expect(content).toContain('package-ecosystem: npm\n directory: "/apps/dashboard"')+ expect(content).toContain('dashboard-security:')+ })++ it('omits the dashboard ecosystem by default', () => {+ expect(dependabotContent(true)).not.toContain('/apps/dashboard')+ })+it('groups security and version updates separately for each ecosystem', () => {const content = dependabotContent(true)// Each ecosystem gets a security group and a version group.