spree / spree_backend

Spree Admin Dashboard

Spree Commerce

An open source eCommerce platform giving you full control and customizability.
Build any eCommerce solution that your business requires.

Slack · Documentation · Website · Roadmap

Getting Started

Visit the Quickstart Guide to set up Spree in 5 minutes.

Enterprise support

Contact us for enterprise support and custom development services. We offer:

• migrations and upgrades,
• delivering your Spree application,
• optimizing your Spree stack.

Features

Customizable and modular

• pick and choose parts you want to use
• customize everything else (storefront, order processing, API, etc)

Composable and API-first

• connect with your existing ecosystem, build custom workflows with ease
• Storefront and Admin API
• Webhooks

Cart and Checkout for any use case

• advanced cart functionality
• over 30 payment provider integrations out of the box
• API to integrate any other payment gateway
• robust discounts system
• store credits, gift cards

Global Commerce ready

• multi-currency
• multi-language
• full translation support for products, categories, and more
• different shipping methods / costs for different regions
• advanced tax calculation

Multi-Store ready

• host multiple brands / stores on a single Spree instance
• each with different branding, configuration, payment methods, shipping options, product catalogs etc

Responsive Admin Panel

Manage and curate products, users, orders, returns, shipments & more

Orders & Post-purchase management

Manage orders, shipments, returns and refunds

Why developers love it

• Runs anywhere - cloud, VPS, Docker, Kubernetes
• Battle Tested - used by thousands of merchants around the globe in all categories since 2007!
• Extensions available adding new features to Spree

What you can build with Spree

Use Spree for any use case. Innovate beyond what's out there.

A headless eCommerce micro-service

Capture orders and payments for whatever you're selling - physical or digital, products or services

A Multi-vendor marketplace

Run your own marketplace with multiple suppliers, each with a dedicated supplier dashboard

A high-ticket B2B eCommerce

Start capturing 6+ figure orders from resellers with safe payments and a checkout process that fits your business model

Wholesale eCommerce

Run your wholesale operation the way your retail partners expect

A SaaS eCommerce platform

Launch a multi-tenant, multi-store platform for your customers, resellers, affiliates in any configuration, eg. B2B2B, B2B2C, B2B2E

Community & Contributing

Spree is an open source project and we love contributions in any form - pull requests, issues, feature ideas!

Follow our Contributing Guide

Join our Slack to meet other community members.

Contact

Contact us and let's go!

License

Spree is released under the New BSD License.

spree_backend's Issues

TinyMCE plugins not found

TinyMCE plugins table, image is not loaded in the editor.

Context

I have the default configuration for the TinyMCE editor. In application.rb I have configured config.tinymce.install = :compile. TinyMCE editor is loaded and works fine but a couple of plugins are not loaded and in the browser console I found the following errors.

And the TinyMCE editor toolbar does not have the toolbar buttons table, image as shown in image.

Your Environment

• Rails Version: 6.1.5
• Ruby Version: 3.0.3
• Spree Version: 4.4.0

Improve admin extension points

I have installed spree_backend the latest version, but side menu is not collapsed when I clicked

I have installed spree_backend the latest version, but side menu is not collapsed when I clicked

Context

side menu not clickable
no response when it is clicked.

Expected Behavior

javascript is not working properly..

Actual Behavior

Possible Fix

Steps to Reproduce

Your Environment

• Version used:
• Gemfile and Gemfile.lock as text in a Gist:
• Any relevant stack traces ("Full trace" preferred):

Fix ransack branch

The Gemfile pins ransack to master branch. The branch was renamed to main in ransack's repository, which breaks bundle install. This should be updated in Gemfile.

views/spree/admin/users/_tabs without <ul>

In admin users views you replace the _sidebar partial for the _tabs partial.
I think you miss one 'ul' markup in the new _tabs partial.
I'm ussing the data-hook="admin_user_tab_options" attribute to deface the partial.

Context

master branch.

Actual Behavior

Wrong html markup

Possible Fix

Add an "ul"

Fix "Stores" tab

On the latest branch, when accessing Configuration -> Stores, we get an error.

Sortable tree helper ignores the engine mount point.

spree_backend/app/helpers/spree/admin/sortable_tree_helper.rb

Line 26 in 3f34de6

sortable_tree_update_url_value: "/api/v2/platform/#{child_resource_name.pluralize}/#{child_resource.id}/reposition"

If Spree::Core::Engine is mounted at /store shouldn't api url be /store/api? Or maybe stimulus controller should prepend the mount point to url somewhere along the way.

rails 6.1.4
spree 4.4.0

Could not resolve "@spree/dashboard" Yarn warning

I've started to get this warning (it says error but it's not fatal) upon starting bin/dev. I wasn't getting this initially (at least I think so), but it started showing up now. I believe the dashboard is external, if that is true, then should it be marked as such?

18:59:47 js.1   | yarn run v1.22.17
18:59:47 js.1   | $ esbuild app/javascript/*.* --bundle --sourcemap --outdir=app/assets/builds --public-path=assets --watch
18:59:47 js.1   | ✘ [ERROR] Could not resolve "@spree/dashboard"
18:59:47 js.1   |
18:59:47 js.1   |     app/javascript/spree-dashboard.js:4:7:
18:59:47 js.1   |       4 │ import "@spree/dashboard"
18:59:47 js.1   |         ╵        ~~~~~~~~~~~~~~~~~~
18:59:47 js.1   |
18:59:47 js.1   |   You can mark the path "@spree/dashboard" as external to exclude it from the bundle, which will remove this error.

Stock's count on hand not updating

Using Spree v4.5.1, I've noticed that whenever I increase the stock quantity then press "Add Stock" button, the "count on hand" never changes. Issue remains whether I add a variant or not.

Looking at the database, count_on_hand on table spree_stock_items is always zero

Rails: 7.0.4
Ruby: 3.1.2
OS: macOS Monterey v12.6

Can not update default locale translation

Context

Can not update site name to Spree Demo Store, but zh-CN translation is ok.

Expected Behavior

Can update site name to Spree Demo Store.

Actual Behavior

Nothing change

Possible Fix

in Spree::Admin::Translatable class, save_translation_values method maybe ignore default locale translation, or direct to update default locale in main table not in translation table.

Steps to Reproduce

1. login in admin
2. click settings > store
3. click translations
4. update form

Your Environment

• Version used: 4.8.2

Resolve issues with tests

Currently some tests are failing randomly or due to the changes in the latest spree/core. We should stabilize these tests to make the test output reliable.

Local development setup

Hi guys,

i setup this project as documented in the Local Setup section of the readme but could not figure out how to start the actual test application. I assume its a dummy spree api where i can play around with the backend right? Or do i really need to "bind" this to my actual spree api/core project to be able to work with? (this would be really cumbersome as i have no clue how to get this yarn/hotwired stuff into docker since im using the recommende spree starter running on docker)

When i run the command "bundle exec rake test_app" it seems to be succesful but it just ends. How do i move on from here? Any help is appreciated

Problem with the product image thumbnail

I found two problems with the product image thumbnail at the page /admin/products/:slug/images :

1. The thumbnail image size would be better to use mini_image instead of product_image, this will increase the performance of the page load especially when the product has many images.
2. The CSS thumbnail image transformation makes the displayed image not full, would be better if the image can be displayed full fit.

From this :

To :

I already created PR to solve the problems above here

Shipping Method display keeps defaults to "both" and always visible on checkout delivery page

Using Rails 7.0.4.2 and ruby 3.1.2 and spree v4.5.1 I've noticed when creating or updating a shipping method and setting it to be displayed to backed, the admin backend dropdown is selecting "All".

I expect when I create or update a shipping method and set "Display" to Admin Panel, I expect the Admin Panel selection to be selected.

I'm using spree_frontend and though, in database, I can see my selection was correct display_on: backend, on the checkout/delivery page, all delivery options are visible.