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.

Improve generated `README.md` by `create-spree-app` (#14196)

Damian Legawiec43267fe66cd5
diff --git a/packages/create-spree-app/CHANGELOG.md b/packages/create-spree-app/CHANGELOG.md
index a791758041..fbafb492aa 100644
--- a/packages/create-spree-app/CHANGELOG.md
+++ b/packages/create-spree-app/CHANGELOG.md
@@ -1,5 +1,11 @@
# create-spree-app
+## 1.0.6
+
+### Patch Changes
+
+- Improve generated README and post-create next steps with links to the Spree documentation, Discord, and CLI.
+
## 1.0.5
### Patch Changes
diff --git a/packages/create-spree-app/package.json b/packages/create-spree-app/package.json
index 83ffba1c41..c06ed8a621 100644
--- a/packages/create-spree-app/package.json
+++ b/packages/create-spree-app/package.json
@@ -1,6 +1,6 @@
{
"name": "create-spree-app",
- "version": "1.0.5",
+ "version": "1.0.6",
"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/scaffold.ts b/packages/create-spree-app/src/scaffold.ts
index f96c4e9d4a..7b0de2a6f5 100644
--- a/packages/create-spree-app/src/scaffold.ts
+++ b/packages/create-spree-app/src/scaffold.ts
@@ -158,6 +158,12 @@ function printSuccessWithoutDocker(
` npx skills add spree/agent-skills`,
` ${pc.dim('# Adds 23 Spree skills to whichever AI agent(s) you use')}`,
` ${pc.dim('# (Claude Code, Codex, Cursor, Copilot, Cline, Aider, +60 others)')}`,
+ '',
+ `${pc.bold('Join our Discord')}`,
+ ` https://discord.spreecommerce.org`,
+ '',
+ `${pc.bold('Learn more')}`,
+ ` https://spreecommerce.org/docs`,
)
p.note(lines.join('\n'), 'Project created!')
diff --git a/packages/create-spree-app/src/templates/readme.ts b/packages/create-spree-app/src/templates/readme.ts
index 63f138b5b4..accd334be9 100644
--- a/packages/create-spree-app/src/templates/readme.ts
+++ b/packages/create-spree-app/src/templates/readme.ts
@@ -52,15 +52,13 @@ npx spree eject
This rebuilds the Docker image from \`backend/\` and restarts services. You can then:
+- **Customize the backend** by editing the files in \`backend/\`
- **Add gems** to \`backend/Gemfile\`
-- **Override models** with decorators in \`backend/app/models/\`
-- **Add controllers** in \`backend/app/controllers/\`
-- **Configure Spree** in \`backend/config/initializers/spree.rb\`
-- **Add migrations** with \`cd backend && bin/rails generate migration\`
+- **Add new resources** with \`spree generate model <name> <attributes>\`
## Spree CLI
-This project uses [\`@spree/cli\`](https://www.npmjs.com/package/@spree/cli) to manage the backend.
+This project uses [\`@spree/cli\`](https://spreecommerce.org/docs/developer/cli/quickstart) to manage the backend.
### Services
@@ -78,6 +76,7 @@ This project uses [\`@spree/cli\`](https://www.npmjs.com/package/@spree/cli) to
| Command | Description |
|---------|-------------|
+| \`spree migrate\` | Install pending Spree migrations from gems, then run them or just run your own migrations |
| \`spree seed\` | Seed the database |
| \`spree sample-data\` | Load sample products, categories, images |
@@ -90,6 +89,15 @@ This project uses [\`@spree/cli\`](https://www.npmjs.com/package/@spree/cli) to
| \`spree api-key list\` | List all API keys |
| \`spree api-key revoke <id>\` | Revoke an API key (ID from \`api-key list\`) |
+### Generators
+
+| Command | Description |
+|---------|-------------|
+| \`spree generate model Brand name:string slug:string:uniq\` | Generate a new database model |
+| \`spree generate api_resource Brand name:string slug:string:uniq\` | Generate a new Spree API resource |
+| \`spree generate subscriber OmsOrderSync order.completed\` | Generate a new event subscriber |
+| \`spree generate migration AddPositionToSpreeBrands position:integer\` | Generate a new database migration |
+
### Admin API
Project setup mints a read-only secret key into \`.spree/credentials.json\` (gitignored), so the Admin API client works out of the box. If you skipped the setup step, \`spree api\` mints the key on first use instead:
@@ -124,7 +132,10 @@ SPREE_API_KEY=sk_... npx spree api post products --data '{"name":"New product","
## Learn More
- [Spree Documentation](https://spreecommerce.org/docs)
-- [Store API Reference](https://spreecommerce.org/docs/api-reference/introduction)
+- [Spree Discord](https://discord.spreecommerce.org)
+- [Store API Reference](https://spreecommerce.org/docs/api-reference/store-api/introduction)
+- [Admin API Reference](https://spreecommerce.org/docs/api-reference/admin-api/introduction)
+- [CLI Reference](https://spreecommerce.org/docs/developer/cli/quickstart)
- [Spree GitHub](https://github.com/spree/spree)
`