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.

Add more sandboxes references in README and docs

Damian Legawiec249dbf3c6846
diff --git a/README.md b/README.md
index c31fcbe058..4c9d9ba4bb 100755
--- a/README.md
+++ b/README.md
@@ -6,9 +6,9 @@
[Website](https://spreecommerce.org)
·
-[Next.js Storefront](https://github.com/spree/storefront)
+[Free Sandbox](https://console.spree.sh)
·
-[Demo](https://demo.spreecommerce.org/)
+[Next.js Storefront](https://github.com/spree/storefront)
·
[Documentation](https://spreecommerce.org/docs/)
·
@@ -29,7 +29,9 @@ Everything you need to launch cross-border storefronts, B2B wholesale, or a cust
## Getting Started
-Copy and paste the following command to your terminal to set up Spree in 5 minutes:
+The fastest way to try Spree is to [create a free sandbox](https://console.spree.sh) — a hosted Spree store with the Admin Dashboard and storefront, nothing to install.
+
+To run Spree locally instead, copy and paste the following command to your terminal to set it up in 5 minutes:
```bash
npx create-spree-app@latest my-store
@@ -91,7 +93,7 @@ You can quickly deploy a Spree store with the button below, or follow our [deplo
[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy?repo=https://github.com/spree/spree-starter)
> **Note**
-> This uses Render's free plan for quick evaluation. Free instances spin down after inactivity and may take 30-60s to wake up. For production, see [recommended sizing](https://spreecommerce.org/docs/developer/deployment/render#production-sizing).
+> This uses Render's free plan for quick evaluation. Free instances spin down after inactivity and may take 30-60s to wake up. For a zero-setup evaluation, [create a free sandbox](https://console.spree.sh) instead. For production, see [recommended sizing](https://spreecommerce.org/docs/developer/deployment/render#production-sizing).
## Screenshots
diff --git a/docs/developer/cli/admin-api.mdx b/docs/developer/cli/admin-api.mdx
index a67b401400..a727e1bd09 100644
--- a/docs/developer/cli/admin-api.mdx
+++ b/docs/developer/cli/admin-api.mdx
@@ -57,6 +57,17 @@ spree auth status
spree auth logout --profile prod
```
+### Use with a sandbox
+
+A [free sandbox](https://console.spree.sh) works like any remote store. Create a secret key in the sandbox admin under **Settings → API Keys**, then save it as a profile:
+
+```bash
+spree auth login --profile sandbox --base-url https://your-store.spree.sh
+spree api get /products --profile sandbox
+```
+
+No local project or Docker needed — the CLI (`npm install -g @spree/cli`) plus a sandbox is a complete environment for exploring the Admin API.
+
## Reading data
`-q` takes [Ransack](/api-reference/admin-api/querying) predicates as repeatable `key=value` pairs; sorting, pagination, and shaping flags pass through under the Admin API conventions: