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.

Advertise sandbox in spree docs

Damian Legawiec79fb08ab031e
diff --git a/docs/developer/getting-started/quickstart.mdx b/docs/developer/getting-started/quickstart.mdx
index 533db001f3..ae8f6f5c14 100644
--- a/docs/developer/getting-started/quickstart.mdx
+++ b/docs/developer/getting-started/quickstart.mdx
@@ -1,9 +1,13 @@
---
title: "Installing Spree"
sidebarTitle: Installation
-description: "Install Spree Commerce locally, run your first store, and deploy it to production with the official starter template."
+description: "Try Spree in a free hosted sandbox, or install it locally, run your first store, and deploy it to production with the official starter template."
---
+<Tip>
+ **Just want to try Spree?** [Launch a free sandbox](https://console.spree.sh) — a hosted Spree store with the admin dashboard and APIs, ready in your browser. Nothing to install. See [Trying Spree in a sandbox](#trying-spree-in-a-sandbox).
+</Tip>
+
## Using `create-spree-app`
The quickest way to get started. Scaffolds a full Spree project with React admin dashboard and Next.js Storefront (optional).
@@ -22,6 +26,16 @@ description: "Install Spree Commerce locally, run your first store, and deploy i
<video autoPlay muted loop playsInline controls className="block w-auto max-w-full h-auto rounded-xl" src="/videos/store-setup.mp4"></video>
</Frame>
+## Trying Spree in a sandbox
+
+A [Spree sandbox](https://console.spree.sh) is a free, hosted Spree store at its own `*.spree.sh` address. Use it to explore the admin dashboard, try the APIs, or point a storefront at it — without installing Node.js, Docker or Ruby.
+
+1. Sign in at [console.spree.sh](https://console.spree.sh) and click **Create store**.
+2. Click **Open** to go to its admin dashboard and manage products, orders and settings.
+3. To call the Admin API, create a secret key under **Settings → API Keys** and use it with the [Spree CLI](/developer/cli/admin-api#use-with-a-sandbox) or the [Admin SDK](/developer/sdk/admin/quickstart).
+
+When you're ready to customize Spree's code, install it locally with `create-spree-app`.
+
## Project structure and overview
`create-spree-app` creates a project folder like this:
diff --git a/docs/index.mdx b/docs/index.mdx
index 7c916296d4..46e74769fa 100644
--- a/docs/index.mdx
+++ b/docs/index.mdx
@@ -144,12 +144,11 @@ export const CopyBox = ({ label, command }) => {
<span className="text-white">Get started</span>
<Icon className="w-4 h-4 text-white"><path d="M5 12h14" /><path d="m12 5 7 7-7 7" /></Icon>
</a>
- {/*
<a href="https://console.spree.sh"
className="inline-flex items-center gap-2 rounded-xl border border-[#d5d5d5] dark:border-[#4a4846] px-6 py-3.5 text-base font-medium text-[#1a1a1a] dark:text-zinc-200 no-underline transition-colors hover:border-[#b3b3b3] dark:hover:border-[#5f5c59]">
- Launch a free sandbox
+ Try a free sandbox
+ <Icon className="w-4 h-4"><path d="M7 7h10v10" /><path d="M7 17 17 7" /></Icon>
</a>
- */}
</div>
<div className="mt-8 max-w-xl">
<CopyBox label="Quick Install" command="npx create-spree-app@latest my-store" />
diff --git a/docs/style.css b/docs/style.css
index 41be72c053..88460eeb8a 100644
--- a/docs/style.css
+++ b/docs/style.css
@@ -343,6 +343,15 @@ html:not(.dark) h4 {
color: var(--spree-accent-strong) !important;
}
+/* Inside callouts Mintlify colours links like the callout's own text, so
+ without the underline they are indistinguishable from it. */
+#content-container [data-callout-type] .link {
+ font-weight: 500;
+ text-decoration: underline !important;
+ text-decoration-thickness: 1px !important;
+ text-underline-offset: 3px !important;
+}
+
.dark #content-container .link {
color: #4d9fff !important;
}