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.

Documentation update

Damian Legawiec26b82f036b66
diff --git a/docs/README.md b/docs/README.md
index 1f7938e0a0..6f83c14005 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -12,17 +12,17 @@ To run the documentation locally, you will need to install the Mintlify CLI.
> Mintlify requires Node.js version 20+ to run.
```bash
-npm i -g mintlify
+npm i -g mint
```
Then you can run the documentation locally with the following command:
```bash
-mintlify dev --port 4000
+mint dev
```
This will start the documentation server on port 4000. You can then view the documentation at [http://localhost:4000](http://localhost:4000).
## License
-Documentation located in this directory is licensed under the [CC BY 4.0](LICENSE.md) license.
\ No newline at end of file
+Documentation located in this directory is licensed under the [CC BY 4.0](LICENSE.md) license.
diff --git a/docs/api-reference/introduction.mdx b/docs/api-reference/introduction.mdx
index d7e708d852..9427680128 100644
--- a/docs/api-reference/introduction.mdx
+++ b/docs/api-reference/introduction.mdx
@@ -19,12 +19,8 @@ Currently Spree includes 2 modern REST APIs:
</Card>
</CardGroup>
-## Legacy REST API v1
-
-Legacy REST API v1 was extracted to `spree_api_v1` gem. It is not recommended to use it in new projects, but it's still available for existing ones.
-
## Thank you!
Give Spree a [GitHub Star](https://github.com/spree/spree)<Icon icon="star" iconType="solid" color="#FFD43B" />, why dont't ya? Thank you for supporting Spree open-source! <Icon icon="heart" iconType="solid" color="#FF0000" />
-Need support or want to give some feedback? Join our [community](https://slack.spreecommerce.org/) with 6000+ members or drop us an email at [[email protected]](mailto:[email protected]).
\ No newline at end of file
+Need support or want to give some feedback? Join our [community](https://slack.spreecommerce.org/) with 6000+ members or drop us an email at [[email protected]](mailto:[email protected]).
diff --git a/docs/developer/core-concepts/adjustments.mdx b/docs/developer/core-concepts/adjustments.mdx
index 844de0636d..878f4e9a9b 100644
--- a/docs/developer/core-concepts/adjustments.mdx
+++ b/docs/developer/core-concepts/adjustments.mdx
@@ -62,7 +62,7 @@ erDiagram
- **Adjustable** is what's being adjusted (Order, LineItem, or Shipment)
- Positive amounts are charges, negative amounts are credits
-An `Adjustment` object tracks an adjustment to the price of an [Order](orders), an order's [Line Item](orders#line-items), or an order's [Shipments](shipments) within a Spree Commerce storefront.
+An `Adjustment` object tracks an adjustment to the price of an [Order](orders), an order's [Line Item](orders#line-items), or an order's [Shipments](shipments) within a Spree application.
Adjustments can be either positive or negative. Adjustments with a positive value are sometimes referred to as "charges" while adjustments with a negative value are sometimes referred to as "credits." These are just terms of convenience since there is only one `Spree::Adjustment` model in a storefront which handles this by allowing either positive or negative values.
@@ -222,4 +222,4 @@ That's it! Your custom adjuster is ready to go.
- [Promotions](/developer/core-concepts/promotions) - Promotion-based adjustments
- [Taxes](/developer/core-concepts/taxes) - Tax adjustments
- [Shipments](/developer/core-concepts/shipments) - Shipping adjustments
-- [Orders](/developer/core-concepts/orders) - How adjustments affect order totals
\ No newline at end of file
+- [Orders](/developer/core-concepts/orders) - How adjustments affect order totals
diff --git a/docs/developer/core-concepts/metafields.mdx b/docs/developer/core-concepts/metafields.mdx
index 3df66499e6..cf8257f505 100644
--- a/docs/developer/core-concepts/metafields.mdx
+++ b/docs/developer/core-concepts/metafields.mdx
@@ -490,7 +490,7 @@ Metafields are automatically included in Platform API responses:
"id": "1",
"type": "product",
"attributes": {
- "name": "Ruby on Rails T-Shirt",
+ "name": "Spree T-Shirt",
// ... other attributes
},
"relationships": {
@@ -530,7 +530,7 @@ Only public metafields (with `display_on` set to `both` or `front_end`) are incl
"id": "1",
"type": "product",
"attributes": {
- "name": "Ruby on Rails T-Shirt"
+ "name": "Spree T-Shirt"
},
"relationships": {
"metafields": {
diff --git a/docs/developer/core-concepts/slugs.mdx b/docs/developer/core-concepts/slugs.mdx
index bbb4a137d3..47d86010cb 100644
--- a/docs/developer/core-concepts/slugs.mdx
+++ b/docs/developer/core-concepts/slugs.mdx
@@ -4,7 +4,7 @@ title: Slugs
## Overview
-Spree uses the [FriendlyId](https://github.com/norman/friendly_id) library to generate SEO-friendly URLs for resources like products, taxons, stores, and more. Instead of accessing resources via database IDs (e.g., `/products/123`), FriendlyId enables clean, readable URLs based on resource names (e.g., `/products/ruby-on-rails-tshirt`).
+Spree uses the [FriendlyId](https://github.com/norman/friendly_id) library to generate SEO-friendly URLs for resources like products, taxons, stores, and more. Instead of accessing resources via database IDs (e.g., `/products/123`), FriendlyId enables clean, readable URLs based on resource names (e.g., `/products/spree-tshirt`).
Slugs are URL-safe strings derived from resource attributes (typically the `name` field) that:
@@ -35,7 +35,7 @@ Slugs are automatically generated from resource attributes using the `to_url` me
```ruby
# Example slug generation
-"Ruby on Rails T-Shirt".to_url # => "ruby-on-rails-t-shirt"
+"Spree T-Shirt".to_url # => "spree-t-shirt"
"Café & Restaurant".to_url # => "cafe-and-restaurant"
```
@@ -72,9 +72,9 @@ For products, the slug candidates are customized to include SKU:
]
# Example progression:
-# 1st attempt: "ruby-on-rails-tshirt"
-# 2nd attempt: "ruby-on-rails-tshirt-TSHIRT-001" (includes SKU)
-# 3rd attempt: "ruby-on-rails-tshirt-a1b2c3d4-e5f6-..." (includes UUID)
+# 1st attempt: "spree-tshirt"
+# 2nd attempt: "spree-tshirt-TSHIRT-001" (includes SKU)
+# 3rd attempt: "spree-tshirt-a1b2c3d4-e5f6-..." (includes UUID)
```
### Reserved Words
@@ -115,19 +115,19 @@ include Spree::Product::Slugs
```ruby
# Creating a product with a slug
product = Spree::Product.create!(
- name: 'Ruby on Rails T-Shirt',
+ name: 'Spree T-Shirt',
stores: [store]
)
-product.slug # => "ruby-on-rails-t-shirt"
+product.slug # => "spree-t-shirt"
# Accessing by slug
-Spree::Product.friendly.find('ruby-on-rails-t-shirt')
+Spree::Product.friendly.find('spree-t-shirt')
# Setting a custom slug
product.update!(slug: 'custom-rails-shirt')
# Translated slugs
-product.set_friendly_id('t-shirt-ruby-on-rails', :fr)
+product.set_friendly_id('t-shirt-spree', :fr)
product.save!
```
@@ -386,7 +386,7 @@ Use the `friendly` scope to find records by slug:
```ruby
# Find by slug
-product = Spree::Product.friendly.find('ruby-on-rails-tshirt')
+product = Spree::Product.friendly.find('spree-tshirt')
# Find by ID still works
product = Spree::Product.friendly.find(123)
@@ -402,10 +402,10 @@ You can override auto-generated slugs:
```ruby
# Auto-generated slug
product = Spree::Product.create!(
- name: 'Ruby on Rails T-Shirt',
+ name: 'Spree T-Shirt',
stores: [store]
)
-product.slug # => "ruby-on-rails-t-shirt"
+product.slug # => "spree-t-shirt"
# Custom slug
product.update!(slug: 'rails-tshirt')
@@ -413,7 +413,7 @@ product.slug # => "rails-tshirt"
# Reset to auto-generate (set to nil)
product.update!(slug: nil)
-product.slug # => "ruby-on-rails-t-shirt" (regenerated from name)
+product.slug # => "spree-t-shirt" (regenerated from name)
```
### Slug Normalization
@@ -633,7 +633,7 @@ end
# API Examples:
# GET /api/v2/storefront/products/123
-# GET /api/v2/storefront/products/ruby-on-rails-tshirt
+# GET /api/v2/storefront/products/spree-tshirt
```
## Best Practices
@@ -848,4 +848,3 @@ end
| `Model.slug_available?(slug, id)` | Check slug availability |
| `resource.friendly_id` | Current friendly ID |
| `resource.set_friendly_id(slug, locale)` | Set slug for locale |
-
diff --git a/docs/developer/customization/extensions.mdx b/docs/developer/customization/extensions.mdx
index 5960136716..421871989f 100644
--- a/docs/developer/customization/extensions.mdx
+++ b/docs/developer/customization/extensions.mdx
@@ -24,7 +24,7 @@ description: >-
title="Spree I18n"
href="https://github.com/spree-contrib/spree_i18n"
>
- Spree I18n is a gem that provides a way to translate Spree Commerce applications into multiple languages. It allows you to translate the UI and have different translations for product descriptions, taxons, etc to improve conversions and customer satisfaction.
+ Spree I18n is a gem that provides a way to translate Spree applications into multiple languages. It allows you to translate the UI and have different translations for product descriptions, taxons, etc to improve conversions and customer satisfaction.
</Card>
<Card
title="Flow Commerce"
diff --git a/docs/developer/deployment/aws.mdx b/docs/developer/deployment/aws.mdx
index 934e2c444a..d632a6fa00 100644
--- a/docs/developer/deployment/aws.mdx
+++ b/docs/developer/deployment/aws.mdx
@@ -1,6 +1,6 @@
---
title: Amazon Web Services (AWS)
-description: Learn how to deploy your Spree Commerce application on Amazon Web Services (AWS).
+description: Learn how to deploy your Spree application on Amazon Web Services (AWS).
---
Amazon Web Services offers reliable, scalable, and inexpensive cloud computing services. AWS is also one of the most popular choices for hosting a Spree application.
@@ -335,4 +335,4 @@ You will need to create two ECS task definitions: one for the web service and on
}
]
}
-```
\ No newline at end of file
+```
diff --git a/docs/developer/getting-started/quickstart.mdx b/docs/developer/getting-started/quickstart.mdx
index c51c64e7a1..38a3c171c1 100644
--- a/docs/developer/getting-started/quickstart.mdx
+++ b/docs/developer/getting-started/quickstart.mdx
@@ -1,20 +1,18 @@
---
title: "Installing Spree"
sidebarTitle: Installation
-description: "Start building awesome eCommerce applications with Spree open-source eg. multi-store, multi-vendor, multi-tenant, multi-language, multi-currency. B2B or B2C."
+description: "Follow the instructions below to learn how to build and deploy your Spree application."
---
-Follow the instructions below to learn how to build and deploy your Spree Commerce store.
-
<Info>
- Spree works with **PostgreSQL**, **MySQL**, and **SQLite** databases. The installer defaults to SQLite for quick setup. You can switch to PostgreSQL or MySQL at any time by updating your `database.yml` or `DATABASE_URL` environment variable. [Learn more about database configuration](/developer/deployment/database).
+ Spree works with **PostgreSQL**, **MySQL**, and **SQLite** databases. The installer defaults to SQLite for quick setup. You can switch to PostgreSQL or MySQL at any time later. [Learn more about database configuration](/developer/deployment/database).
</Info>
-## 1. Installing Spree
+## Installation options
<Tabs>
<Tab title="Spree Installer">
- Use the guided installer to set up your Spree Commerce application with all the required dependencies (Ruby, Rails, etc.) on your system.
+ Use the guided installer to set up your Spree application with all the required dependencies (system libraries, Ruby language) on your system.
Copy and paste the following command to your terminal:
@@ -22,21 +20,18 @@ Follow the instructions below to learn how to build and deploy your Spree Commer
bash -c "$(curl -fsSL https://spreecommerce.org/install)"
```
- This will fire up the guided installer that will ask you a few questions (eg. application name, load sample data, etc.) and then set up your Spree Commerce application.
+ This will fire up the guided installer that will ask you a few questions (eg. application name, load sample data, etc.) and then set up your Spree application.
<Info>
- On Windows please install WSL (Windows Subsystem for Linux) first.
- ```bash
- wsl --install
- ```
- Then run the installer from within WSL.
- </Info>
-
- <Warning>
- Minimum system requirements for MacOS:
+ **System Requirements**
+
+ MacOS:
* MacOS 14.0+
* XCode command line tools installed
- </Warning>
+
+ Windows:
+ * Windows Subsystem for Linux is required, you can install it via `wsl --install`
+ </Info>
<Info>
If you have any issues with the installer, please create an issue on [GitHub](https://github.com/spree/spree/issues/new). Thank you!
@@ -51,7 +46,7 @@ Follow the instructions below to learn how to build and deploy your Spree Commer
```bash
gem install rails
```
- 4. Run the following command to create a new Spree Commerce application:
+ 4. Run the following command to create a new Spree application:
```bash
rails new my_store -m https://raw.githubusercontent.com/spree/spree/main/spree/template.rb
```
@@ -75,9 +70,7 @@ Follow the instructions below to learn how to build and deploy your Spree Commer
</Tab>
</Tabs>
-## 2. Exploring Your Store
-
-Feel free to explore your store. You can do so because Spree comes with a default pre-built Storefront and Admin Panel.
+## Accessing Admin Panel
Use your browser window to navigate to [http://localhost:3000/admin](http://localhost:3000/admin). You can log in with the credentials you've chosen during installation, the defaults are:
@@ -99,9 +92,7 @@ Upon successful authentication, you should see the admin screen:
<img src="/images/spree_admin_dashboard.png" />
</Frame>
-Feel free to explore some of the Admin Panel features that Spree has to offer and to verify that your installation is working properly.
-
-### All Done!
+---
Congrats! You've set up your Spree Commerce and it's looking amazing!
diff --git a/docs/developer/multi-store/quickstart.mdx b/docs/developer/multi-store/quickstart.mdx
index b6364a80f2..835090e57b 100644
--- a/docs/developer/multi-store/quickstart.mdx
+++ b/docs/developer/multi-store/quickstart.mdx
@@ -38,7 +38,7 @@ Spree will try to determine the current store based on the current URL. If the U
All Spree controllers or any other controllers that include [Spree::Core::ControllerHelpers::Store](https://github.com/spree/spree/blob/main/core/lib/spree/core/controller_helpers/store.rb) have access to the `current_store` method which returns the `Store` matching the current URL.
-All parts of Spree (API v1, API v2, Storefront, Admin Panel) have this implemented. This method is also available in views and JSON serializers.
+All parts of Spree (API, Admin Panel) have this implemented.
<Info>
Under the hood `current_store` calls [Spree::Stores::FindCurrent.new(url: url).execute](https://github.com/spree/spree/blob/main/core/app/finders/spree/stores/find_current.rb).
diff --git a/docs/developer/upgrades/5.3-to-5.4.mdx b/docs/developer/upgrades/5.3-to-5.4.mdx
index 7e6d08b7ba..047e5acf9f 100644
--- a/docs/developer/upgrades/5.3-to-5.4.mdx
+++ b/docs/developer/upgrades/5.3-to-5.4.mdx
@@ -168,7 +168,7 @@ And run `bundle install`
### (Optional) Install Spree Multi Store
-Multi-store features like multiple store management & custom domains were moved to a seperate gem `spree_multi_store`.
+Multi-store features like multiple store management & custom domains were moved to a separate gem `spree_multi_store`.
If you rely on these features please run:
diff --git a/docs/index.mdx b/docs/index.mdx
index d11401586a..2052314c94 100644
--- a/docs/index.mdx
+++ b/docs/index.mdx
@@ -1,6 +1,6 @@
---
title: "Introduction"
-description: "Start building your eCommerce solution with our flexible open source eCommerce platform."
+description: "The open-source commerce engine that adapts to your stack, your business model, and your scale."
mode: "custom"
---
@@ -26,11 +26,11 @@ export const HeroCard = ({ filename, title, description, href }) => {
<div className="relative">
<div className="relative z-10 px-4 py-16 max-w-3xl mx-auto">
<h1 className="block text-4xl font-medium text-center text-gray-900 dark:text-zinc-50 tracking-tight">
- Spree Commerce Documentation
+ Spree Documentation
</h1>
<div className="max-w-xl mx-auto px-4 mt-4 text-lg text-center text-gray-500 dark:text-zinc-500">
- Start building your eCommerce solution with our flexible open source eCommerce platform.
+ The open-source commerce engine that adapts to your stack, your business model, and your scale
</div>
<div className="px-6 lg:px-0 mt-12 grid sm:grid-cols-2 gap-x-6 gap-y-4">
@@ -39,7 +39,7 @@ export const HeroCard = ({ filename, title, description, href }) => {
<HeroCard
filename="api"
title="API Reference"
- description="Explore the Spree Commerce API reference"
+ description="Explore the Spree API reference"
href="/api-reference"
/>
@@ -53,9 +53,9 @@ export const HeroCard = ({ filename, title, description, href }) => {
<HeroCard
filename="integrations"
title="Integrations"
- description="Integrate Spree Commerce with your favorite tools and services"
+ description="Integrate Spree with your favorite tools and services"
href="/integrations"
/>
</div>
</div>
-</div>
\ No newline at end of file
+</div>
diff --git a/docs/integrations/integrations.mdx b/docs/integrations/integrations.mdx
index fe7bf17abb..52f2707ad6 100644
--- a/docs/integrations/integrations.mdx
+++ b/docs/integrations/integrations.mdx
@@ -1,7 +1,7 @@
---
title: "3rd party integrations"
sidebarTitle: "All Integrations"
-description: "Learn how to connect your Spree Commerce store to third-party services and platforms."
+description: "Learn how to connect your Spree application to third-party services and platforms."
---
## Payments
diff --git a/docs/user/storefront/storefront-settings.mdx b/docs/user/storefront/storefront-settings.mdx
index 18fa9ae322..fa08f7b01d 100644
--- a/docs/user/storefront/storefront-settings.mdx
+++ b/docs/user/storefront/storefront-settings.mdx
@@ -82,7 +82,7 @@ Displayed when your site is shared on social media or messaging apps.
## Social Media Links
-![Add social media links to your Spree Commerce store](/docs/images/user/storefront/settings/7-social-media.png)
+![Add social media links to your Spree application](/docs/images/user/storefront/settings/7-social-media.png)
Add social handles to your footer, complete with platform-specific icons.
diff --git a/install.sh b/install.sh
index 5680a32510..be776c2126 100755
--- a/install.sh
+++ b/install.sh
@@ -894,12 +894,12 @@ create_rails_app() {
# Run rails new with the template using the specific rails binary
if [ "$VERBOSE" = true ]; then
- print_step "Creating Spree Commerce application '$APP_NAME'..."
+ print_step "Creating Spree application '$APP_NAME'..."
VERBOSE_MODE=1 LOAD_SAMPLE_DATA="$LOAD_SAMPLE_DATA" STOREFRONT_TYPE="$STOREFRONT_TYPE" USE_LOCAL_SPREE="$use_local_spree" ADMIN_EMAIL="$ADMIN_EMAIL" ADMIN_PASSWORD="$ADMIN_PASSWORD" "$RAILS_BIN" _${RAILS_VERSION}_ new "$APP_NAME" -m "$TEMPLATE_FILE"
else
# Run with gum spinner
echo ""
- gum spin --spinner dot --title "Creating Spree Commerce application '$APP_NAME' (this will take several minutes)..." -- \
+ gum spin --spinner dot --title "Creating Spree application '$APP_NAME' (this will take several minutes)..." -- \
bash -c "VERBOSE_MODE=0 LOAD_SAMPLE_DATA=\"$LOAD_SAMPLE_DATA\" STOREFRONT_TYPE=\"$STOREFRONT_TYPE\" USE_LOCAL_SPREE=\"$use_local_spree\" ADMIN_EMAIL=\"$ADMIN_EMAIL\" ADMIN_PASSWORD=\"$ADMIN_PASSWORD\" \"$RAILS_BIN\" _${RAILS_VERSION}_ new \"$APP_NAME\" -m \"$TEMPLATE_FILE\" >/tmp/spree_install.log 2>&1"
local exit_code=$?
@@ -935,7 +935,7 @@ create_rails_app() {
rm -f /tmp/spree_install.log
fi
- print_success "Spree Commerce application created successfully"
+ print_success "Spree application created successfully"
}
# Final instructions
diff --git a/packages/next/README.md b/packages/next/README.md
index cf26759bdf..a9da4815a0 100644
--- a/packages/next/README.md
+++ b/packages/next/README.md
@@ -94,7 +94,7 @@ Plain async functions for reading data in Server Components. Wrap with `"use cac
import { listProducts, getProduct, getProductFilters } from '@spree/next';
const products = await listProducts({ per_page: 25, includes: 'variants,images' });
-const product = await getProduct('ruby-on-rails-tote');
+const product = await getProduct('spree-tote');
const filters = await getProductFilters({ taxon_id: 'txn_123' });
```
diff --git a/packages/sdk/README.md b/packages/sdk/README.md
index adfb914616..e37f52d0fe 100644
--- a/packages/sdk/README.md
+++ b/packages/sdk/README.md
@@ -31,7 +31,7 @@ const products = await client.store.products.list({
});
// Get a single product
-const product = await client.store.products.get('ruby-on-rails-tote');
+const product = await client.store.products.get('spree-tote');
// Authentication
const { token, user } = await client.store.auth.login({
@@ -153,7 +153,7 @@ const products = await client.store.products.list({
});
// Get single product by ID or slug
-const product = await client.store.products.get('ruby-on-rails-tote', {
+const product = await client.store.products.get('spree-tote', {
includes: 'variants,images',
});
diff --git a/spree/admin/README.md b/spree/admin/README.md
index 13505d1db4..89f5e5dfa5 100644
--- a/spree/admin/README.md
+++ b/spree/admin/README.md
@@ -2,7 +2,7 @@
[![Gem Version](https://badge.fury.io/rb/spree_admin.svg)](https://badge.fury.io/rb/spree_admin)
-Spree Admin provides a modern, fully-featured admin dashboard for managing your Spree Commerce store.
+Spree Admin provides a modern, fully-featured admin dashboard for managing your Spree application.
## Overview
@@ -147,4 +147,4 @@ end
- [Admin Customization Guide](https://docs.spreecommerce.org/developer/customization/admin)
- [Navigation Configuration](https://docs.spreecommerce.org/developer/customization/admin-navigation)
-- [Permissions Guide](https://docs.spreecommerce.org/developer/customization/permissions)
\ No newline at end of file
+- [Permissions Guide](https://docs.spreecommerce.org/developer/customization/permissions)