Architecture
Learn about the Spree architecture
Core
Core is the foundation of Spree, such as models, services, and the backend logic necessary to run an e-commerce business.
Admin Dashboard
The Admin Dashboard is the control center for your Spree store. It allows you to manage products, orders, customers, and more.
Storefront
The Storefront is the public-facing part of your Spree store where customers can browse products, add them to their cart, and complete purchases.
Emails
Spree includes built-in support for sending transactional emails to customers, such as order confirmations and shipping notifications.
Storefront API
The Storefront API allows developers to interact with the Spree store programmatically, enabling custom front-end experiences and integrations.
Platform API
The Platform API provides a comprehensive set of endpoints for managing all aspects of the Spree store, including products, orders, and customers.
Webhooks
Webhooks allow your Spree store to send real-time notifications to external systems when certain events occur, such as order creation or payment completion.
Code Conventions
Spree is built on top of Ruby on Rails framework and follows Model-View-Controller (MVC) architecture. As an example let’s look at the Product model.- the model itself is located in app/models/spree/product.rb and is named
Spree::Product - the controller is located in app/controllers/spree/products_controller.rb and is named
Spree::ProductsController - views for that controller are located in app/views/spree/products directory
Spree namespace. Thanks to this convention, it’s easy to identify Spree code in a Rails application and we will not have any conflicts with your application code or other libraries.