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 edits made through Mintlify web editor

mintlify[bot]9067a4bcf0dd
diff --git a/docs/user/user-quickstart-guide.mdx b/docs/user/user-quickstart-guide.mdx
index 8783a77b8e..eb02e643b9 100644
--- a/docs/user/user-quickstart-guide.mdx
+++ b/docs/user/user-quickstart-guide.mdx
@@ -113,27 +113,27 @@ To view the live storefront, click on the View Store button on the top right cor
With a little investment of your time, you can turn this into something presentable, shoppable, and on-brand without the need to hire developers (or even designers if it’s an MVP).
-<img alt="Styled Store on Spree" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/v1733327026/docs/Getting%20Started/1.12_Getting_Started_-_Modified_Store_tfdwxm.png" />
+<img alt="Styled Store on Spree" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327026/docs/Getting%20Started/1.12_Getting_Started_-_Modified_Store_tfdwxm.png" />
#### Connect Your Own Domain
At the top of the Theme section, you’ll notice a prompt to connect your own domain. Clicking on this will lead you to the Domains section of Settings where you can connect your domains and subdomains.
-<img alt="Connect Your own Domain" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/v1733327026/docs/Getting%20Started/1.13_Getting_Started_-_Connect_Your_own_Domain_ay8q1s.png" />
+<img alt="Connect Your own Domain" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327026/docs/Getting%20Started/1.13_Getting_Started_-_Connect_Your_own_Domain_ay8q1s.png" />
#### Theme Editor
To edit the store’s default Theme, simply click on it or click the three dots on the left and select Edit.
-<img alt="Theme Editor" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/v1733327026/docs/Getting%20Started/1.14_Getting_Started_-_Theme_Editor_qxfbsu.png" />
+<img alt="Theme Editor" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327026/docs/Getting%20Started/1.14_Getting_Started_-_Theme_Editor_qxfbsu.png" />
This will open the visual page builder UI that allows you to easily add or modify page sections, upload visual media, and change color schemes and fonts.
-<img alt="Drag & Drop Visual Page Builder Composer" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/v1733327026/docs/Getting%20Started/1.15_Getting_Started_-_Page_Builder_c63a2a.png" />
+<img alt="Drag & Drop Visual Page Builder Composer" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327026/docs/Getting%20Started/1.15_Getting_Started_-_Page_Builder_c63a2a.png" />
Themes are mobily-reponsive, and you can switch between views by clicking on the mobile or desktop icons in the top right corner.
-<img alt="Page Builder Mobile View" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/v1733327026/docs/Getting%20Started/1.16_Getting_Started_-_Page_Builder_Mobile_View_qbmdp9.png" />
+<img alt="Page Builder Mobile View" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327026/docs/Getting%20Started/1.16_Getting_Started_-_Page_Builder_Mobile_View_qbmdp9.png" />
Important: Whenever you make changes to the storefront, it’s important to publish them before backing out of the page builder otherwise all progress will be lost. To publish changes, click the blue button in the top right corner.
@@ -141,39 +141,39 @@ You can also preview changes you’ve made to the storefront without publishing
For a comprehensive guide to using the page builder, please refer to this support article: \{\{LINK TO PAGE BUILDER}}
-### Pages 
+### Pages
This where you can add static pages to your store, such as About Us, Contact Us, landing pages, etc.
-<img alt="Content Pages" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/v1733327027/docs/Getting%20Started/1.17_Getting_Started_-_Pages_didkze.png" />
+<img alt="Content Pages" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327027/docs/Getting%20Started/1.17_Getting_Started_-_Pages_didkze.png" />
To add a new page, simply click on the blue button in the top right corner, give the page a name, edit the SEO settings, and then click Create at the bottom of the page.
-<img alt="Add A New Page" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/v1733327027/docs/Getting%20Started/1.18_Getting_Started_-_Add_A_New_Page_mmht9c.png" />
+<img alt="Add A New Page" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327027/docs/Getting%20Started/1.18_Getting_Started_-_Add_A_New_Page_mmht9c.png" />
After creating the page, you’ll be redirected to the page builder where you can configure the layout and insert content for the new page.
-<img alt="Publish New Page" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/v1733327027/docs/Getting%20Started/1.19_Getting_Started_-_Publish_New_Page_huxsg6.png" />
+<img alt="Publish New Page" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327027/docs/Getting%20Started/1.19_Getting_Started_-_Publish_New_Page_huxsg6.png" />
Once you’re finished, click Publish and the new page will be added to your store.
-<img alt="New Page Added" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/v1733327027/docs/Getting%20Started/1.20_Getting_Started_-_New_Page_Added_z5zikq.png" />
+<img alt="New Page Added" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327027/docs/Getting%20Started/1.20_Getting_Started_-_New_Page_Added_z5zikq.png" />
You can edit pages at any time by simpling clicking on them, and you can delete the page by navigating to Page Settings at the top left of the page builder, and clicking Delete.
-<img alt="Delete A Page" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/v1733327028/docs/Getting%20Started/1.21_Getting_Started_-_Delete_A_Page_nydiix.png" />
+<img alt="Delete A Page" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327028/docs/Getting%20Started/1.21_Getting_Started_-_Delete_A_Page_nydiix.png" />
### Posts
Here you can make use of Spree’s built-in blog to add blog posts to your store. Adding blog posts to your store is a great way to improve SEO, and the posts themselves can be used for social sharing or ads.
-<img alt="Posts" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/v1733327027/docs/Getting%20Started/1.22_Getting_Started_-_Posts_axgngz.png" />
+<img alt="Posts" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327027/docs/Getting%20Started/1.22_Getting_Started_-_Posts_axgngz.png" />
To add a new post, simply click on the blue button in the top right corner.
Note: If you’re using Spree Enterprise Edition, you can import blog posts in bulk from your previous site by uploading a CSV file.
-<img alt="Add A New Post" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/v1733327029/docs/Getting%20Started/1.23_Getting_Started_-_Add_A_New_Post_kkg1kw.png" />
+<img alt="Add A New Post" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327029/docs/Getting%20Started/1.23_Getting_Started_-_Add_A_New_Post_kkg1kw.png" />
This will redirect you to the blog post editor where you can add content, visual media, and modify SEO settings for the new post.
@@ -181,19 +181,19 @@ Make sure to add a Published At date, otherwise it won’t appear on the live si
Once you’re done, click Create to add the new blog post to site.
-<img alt="Publish New Post" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/v1733327028/docs/Getting%20Started/1.24_Getting_Started_-_Publish_New_Post_ee0xos.png" />
+<img alt="Publish New Post" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327028/docs/Getting%20Started/1.24_Getting_Started_-_Publish_New_Post_ee0xos.png" />
You can edit old blog posts by simply clicking on them, making changes, and then clicking Update at the bottom of the page.
Here’s the new blog post on the storefront:
-<img alt="New Post Storefront View" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/v1733327030/docs/Getting%20Started/1.25_Getting_Started_-_New_Post_Storefront_View_meloyu.png" />
+<img alt="New Post Storefront View" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327030/docs/Getting%20Started/1.25_Getting_Started_-_New_Post_Storefront_View_meloyu.png" />
### Storefront Settings
This is where you can configure some important settings for the storefront, such as SEO, security, favicon and social sharing images, and social media links.
-<img alt="Storefront_Settings" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/v1733327029/docs/Getting%20Started/1.26_Getting_Started_-_Storefront_Settings_q94xc6.png" />
+<img alt="Storefront_Settings" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327029/docs/Getting%20Started/1.26_Getting_Started_-_Storefront_Settings_q94xc6.png" />
Important: If you want your store to be shown in search engines, make sure to uncheck the box next to “Do not show in search engines” in the SEO section of the settings.
@@ -203,11 +203,11 @@ To learn more about Storefront Settings, please refer to this support article: \
If you’d like to add multiple storefronts with completely different user experiences, product offerings, payment methods, etc., you can easily add a new store by clicking on the store name in the top left corner, and selecting New Store from the dropdown.
-<img alt="Add A New Store" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/v1733327029/docs/Getting%20Started/1.27_Getting_Started_-_Add_A_New_Store_mrbisv.png" />
+<img alt="Add A New Store" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327029/docs/Getting%20Started/1.27_Getting_Started_-_Add_A_New_Store_mrbisv.png" />
The popup that appears will ask you to give the new store a name, select the country and currency, and to select whether or not to import products and payment methods from the original store.
-<img alt="Configure New Store Settings" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/v1733327029/docs/Getting%20Started/1.28_Getting_Started_-_Configure_New_Store_Settings_p7mwlb.png" />
+<img alt="Configure New Store Settings" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327029/docs/Getting%20Started/1.28_Getting_Started_-_Configure_New_Store_Settings_p7mwlb.png" />
To learn more about the multi-store feature, please refer to this support article: \{\{LINK TO MULTI-STORE}}
@@ -217,7 +217,7 @@ The home screen gives you an overview of your stores results over a time period
It highlights some important sales KPIs and visitor metrics so you can see how business is going at a glance.
-<img alt="Home Screen" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/v1733327030/docs/Getting%20Started/1.29_Getting_Started_-_Home_Screen_pehjal.png" />
+<img alt="Home Screen" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327030/docs/Getting%20Started/1.29_Getting_Started_-_Home_Screen_pehjal.png" />
### Key Sales KPIs
@@ -225,13 +225,13 @@ At the top of the page, there’s a chart that depicts some of the key sales KPI
You change the time period by clicking on the date and then selecting the desired dates.
-<img alt="Sales KPIs" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/v1733327030/docs/Getting%20Started/1.30_Getting_Started_-_Sales_KPIs_pevyhk.png" />
+<img alt="Sales KPIs" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327030/docs/Getting%20Started/1.30_Getting_Started_-_Sales_KPIs_pevyhk.png" />
### Top products
Below the KPIs, you’ll see a section that shows a list of the top selling products, with the option to view the full report.
-<img alt="Top_Products" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/v1733327030/docs/Getting%20Started/1.31_Getting_Started_-_Top_Products_r37mpk.png" />
+<img alt="Top_Products" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327030/docs/Getting%20Started/1.31_Getting_Started_-_Top_Products_r37mpk.png" />
### Visitor Data
@@ -245,7 +245,7 @@ At the bottom of the page, there are four sections that provide data on your aud
* Visitor devices
-<img alt="Visitor_Data" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/v1733327030/docs/Getting%20Started/1.32_Getting_Started_-_Visitor_Data_pugv5j.png" />
+<img alt="Visitor_Data" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327030/docs/Getting%20Started/1.32_Getting_Started_-_Visitor_Data_pugv5j.png" />
### Google Analytics