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.

Mark some tutorial steps as strictly backend customization

Damian Legawiecfffab70760fa
diff --git a/docs/developer/tutorial/admin.mdx b/docs/developer/tutorial/admin.mdx
index 2488eeb742..08efc01237 100644
--- a/docs/developer/tutorial/admin.mdx
+++ b/docs/developer/tutorial/admin.mdx
@@ -3,6 +3,10 @@ title: Admin Dashboard
description: Scaffold the Spree admin UI for the Brands resource and add a rich text description editor, an Active Storage logo upload, and a custom table column.
---
+<Note>
+ This is a backend customization. You need to perform it in the `backend` directory if you used `create-spree-app` to set up your Spree application.
+</Note>
+
Now that we've created the `Brand` model, let's create an Admin Dashboard interface so admins can manage brands — including editing the rich text description and uploading the logo.
## Step 1: Scaffold the Admin UI
diff --git a/docs/developer/tutorial/api.mdx b/docs/developer/tutorial/api.mdx
index e6117c01cd..425c95ca80 100644
--- a/docs/developer/tutorial/api.mdx
+++ b/docs/developer/tutorial/api.mdx
@@ -4,6 +4,10 @@ sidebarTitle: API
description: Expose your custom Brand model through the Spree Store and Admin REST APIs with serializers, controllers, routes, and the spree:api_resource generator.
---
+<Note>
+ This is a backend customization. You need to perform it in the `backend` directory if you used `create-spree-app` to set up your Spree application.
+</Note>
+
In this tutorial, we'll expose our Brand model through Spree's v3 API — the customer-facing **Store API** that storefronts read from, and the back-office **Admin API** with full CRUD for apps and integrations. We'll also extend the existing Product serializer to include brand data.
<Info>
diff --git a/docs/developer/tutorial/extending-models.mdx b/docs/developer/tutorial/extending-models.mdx
index 81580690b7..8f8631d74a 100644
--- a/docs/developer/tutorial/extending-models.mdx
+++ b/docs/developer/tutorial/extending-models.mdx
@@ -3,6 +3,10 @@ title: Extending Core Models
description: Tutorial — extend Spree's core models with a custom Brand resource, generate a migration, and associate it with Products via a decorator.
---
+<Note>
+ This is a backend customization. You need to perform it in the `backend` directory if you used `create-spree-app` to set up your Spree application.
+</Note>
+
In this tutorial, we'll connect our custom Brand model with Spree's core Product model. This is a common pattern when building features that need to integrate with existing Spree functionality.
<Info>
diff --git a/docs/developer/tutorial/model.mdx b/docs/developer/tutorial/model.mdx
index 6b541b84c0..59ca8588f3 100644
--- a/docs/developer/tutorial/model.mdx
+++ b/docs/developer/tutorial/model.mdx
@@ -3,6 +3,10 @@ title: Model
description: Create a custom Brand model in Spree with database columns, a rich text description, and an Active Storage logo upload using a single generator command.
---
+<Note>
+ This is a backend customization. You need to perform it in the `backend` directory if you used `create-spree-app` to set up your Spree application.
+</Note>
+
In this step we'll create the `Spree::Brand` model with everything it needs: a `name` column, a rich text `description`, and an uploadable `logo`.
## Step 1: Generate the Model