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.

Fixed: create-spree-app - properly pass API key and add worker

Damian Legawiec1875e7611e93
diff --git a/packages/create-spree-app/CHANGELOG.md b/packages/create-spree-app/CHANGELOG.md
index 7f996ed7cb..2cb3fe7c19 100644
--- a/packages/create-spree-app/CHANGELOG.md
+++ b/packages/create-spree-app/CHANGELOG.md
@@ -1,5 +1,11 @@
# create-spree-app
+## 0.1.2
+
+### Patch Changes
+
+- Add background worker service to Docker Compose for Solid Queue job processing, rename service from `spree` to `web`/`worker`
+
## 0.1.1
### Patch Changes
diff --git a/packages/create-spree-app/package.json b/packages/create-spree-app/package.json
index e3db8f0142..f978adc850 100644
--- a/packages/create-spree-app/package.json
+++ b/packages/create-spree-app/package.json
@@ -1,6 +1,6 @@
{
"name": "create-spree-app",
- "version": "0.1.1",
+ "version": "0.1.2",
"description": "Create a new Spree Commerce project with a single command",
"type": "module",
"bin": "./dist/index.js",
diff --git a/packages/create-spree-app/src/docker.ts b/packages/create-spree-app/src/docker.ts
index e9e7ce3806..e1fed5ba87 100644
--- a/packages/create-spree-app/src/docker.ts
+++ b/packages/create-spree-app/src/docker.ts
@@ -31,17 +31,22 @@ export async function fetchApiKey(projectDir: string): Promise<string> {
const { stdout } = await execa(
'docker',
- ['compose', 'exec', '-T', 'spree', 'bin/rails', 'runner', script],
+ ['compose', 'exec', '-T', 'web', 'bin/rails', 'runner', script],
{ cwd: projectDir },
)
- return stdout.trim()
+ // Rails boot may print noise (e.g. "[Spree Events] ...") to stdout — extract just the token
+ const match = stdout.match(/pk_[A-Za-z0-9]+/)
+ if (!match) {
+ throw new Error(`Could not extract API key from Rails output: ${stdout}`)
+ }
+ return match[0]
}
export async function loadSampleData(projectDir: string): Promise<void> {
await execa(
'docker',
- ['compose', 'exec', '-T', 'spree', 'bin/rails', 'spree:load_sample_data'],
+ ['compose', 'exec', '-T', 'web', 'bin/rails', 'spree:load_sample_data'],
{ cwd: projectDir, stdio: 'ignore' },
)
}
diff --git a/packages/create-spree-app/src/templates/docker-compose.ts b/packages/create-spree-app/src/templates/docker-compose.ts
index a9e0a06f08..0079e8df21 100644
--- a/packages/create-spree-app/src/templates/docker-compose.ts
+++ b/packages/create-spree-app/src/templates/docker-compose.ts
@@ -14,7 +14,7 @@ export function dockerComposeContent(): string {
timeout: 5s
retries: 5
- spree:
+ web:
image: ${SPREE_IMAGE}:${SPREE_VERSION_TAG}
depends_on:
postgres:
@@ -38,6 +38,21 @@ export function dockerComposeContent(): string {
retries: 10
start_period: 30s
+ worker:
+ image: ${SPREE_IMAGE}:${SPREE_VERSION_TAG}
+ depends_on:
+ web:
+ condition: service_healthy
+ env_file: .env
+ environment:
+ DATABASE_URL: postgres://postgres@postgres:5432/spree_production
+ CACHE_DATABASE_URL: postgres://postgres@postgres:5432/spree_production_cache
+ QUEUE_DATABASE_URL: postgres://postgres@postgres:5432/spree_production_queue
+ CABLE_DATABASE_URL: postgres://postgres@postgres:5432/spree_production_cable
+ RAILS_ENV: production
+ RAILS_LOG_TO_STDOUT: "true"
+ command: bin/jobs
+
volumes:
postgres_data:
`
diff --git a/packages/create-spree-app/src/templates/env.ts b/packages/create-spree-app/src/templates/env.ts
index 60a6d66256..c1b586b5c1 100644
--- a/packages/create-spree-app/src/templates/env.ts
+++ b/packages/create-spree-app/src/templates/env.ts
@@ -7,7 +7,7 @@ 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'}
+ return `SPREE_API_URL=http://localhost:${SPREE_PORT}
+SPREE_PUBLISHABLE_KEY=${apiKey ?? 'pk_REPLACE_ME_AFTER_DOCKER_START'}
`
}
diff --git a/packages/create-spree-app/src/templates/package-json.ts b/packages/create-spree-app/src/templates/package-json.ts
index 29744158b0..0990ffdacb 100644
--- a/packages/create-spree-app/src/templates/package-json.ts
+++ b/packages/create-spree-app/src/templates/package-json.ts
@@ -5,10 +5,11 @@ export function rootPackageJsonContent(name: string): string {
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',
+ logs: 'docker compose logs -f web',
+ 'logs:worker': 'docker compose logs -f worker',
+ 'seed': 'docker compose exec web bin/rails db:seed',
+ 'load-sample-data': 'docker compose exec web bin/rails spree:load_sample_data',
+ console: 'docker compose exec web bin/rails c',
},
}
diff --git a/packages/create-spree-app/src/templates/readme.ts b/packages/create-spree-app/src/templates/readme.ts
index 818bc269d2..45d376afa5 100644
--- a/packages/create-spree-app/src/templates/readme.ts
+++ b/packages/create-spree-app/src/templates/readme.ts
@@ -46,9 +46,10 @@ Open http://localhost:${STOREFRONT_PORT}
|---------|-------------|
| \`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 |
+| \`docker compose logs -f web\` | View web server logs |
+| \`docker compose logs -f worker\` | View background jobs logs |
+| \`docker compose exec web bin/rails c\` | Rails console |
+| \`docker compose exec web bin/rails spree:load_sample_data\` | Load sample products |
## Learn More
diff --git a/packages/create-spree-app/tests/templates.test.ts b/packages/create-spree-app/tests/templates.test.ts
index 98fcecaaa9..f1517f9923 100644
--- a/packages/create-spree-app/tests/templates.test.ts
+++ b/packages/create-spree-app/tests/templates.test.ts
@@ -16,10 +16,14 @@ describe('dockerComposeContent', () => {
expect(content).toContain('postgres:17-alpine')
})
- it('includes healthcheck for spree', () => {
+ it('includes healthcheck for web service', () => {
expect(content).toContain('curl -f http://localhost:3000/up')
})
+ it('includes worker service with bin/jobs command', () => {
+ expect(content).toContain('command: bin/jobs')
+ })
+
it('includes volume definition', () => {
expect(content).toContain('postgres_data:')
})
@@ -65,12 +69,12 @@ describe('storefrontEnvContent', () => {
it('includes real key when provided', () => {
const content = storefrontEnvContent('pk_test123')
- expect(content).toContain('NEXT_PUBLIC_SPREE_PUBLISHABLE_KEY=pk_test123')
+ expect(content).toContain('SPREE_PUBLISHABLE_KEY=pk_test123')
})
it('includes API URL', () => {
const content = storefrontEnvContent()
- expect(content).toContain('NEXT_PUBLIC_SPREE_API_URL=http://localhost:3000')
+ expect(content).toContain('SPREE_API_URL=http://localhost:3000')
})
})