docs

What is the Storefront Application V3

SCAYLE Storefront logo above a performance timeline of the shop interface

The Storefront Application V3 is the front end of an online shop that runs on the SCAYLE Commerce Engine, the SCAYLE platform that holds your products, prices, and orders. It is a working shop with product pages, search, a basket, checkout, and customer accounts. Your development team gets its own copy of the code, called a fork, applies your shop's branding and business rules, and connects it to your SCAYLE shop.

What you get

The Storefront Application V3 includes:

  • Product listing and product detail pages, with filters, sorting, and recommendations, plus search, site navigation, and a wishlist.
  • A basket and a checkout, with the pricing, sales, campaigns, and promotion codes of your shop.
  • Customer accounts, with sign-in, registration, and order history.
  • Content pages, through a connection to a third-party CMS (Storyblok, Contentful, Contentstack, or Amplience), so your shop's marketing content sits alongside its products. A placeholder provider lets the application run before you connect one.
  • Several countries and languages from one deployment, see Localization.

Many features need nothing beyond your shop's data. Others need setup in the SCAYLE Panel, or a SCAYLE add-on such as the Subscription Add-on. Features that rely on a third-party provider are optional. You only need an account if you choose a third-party provider for content management, product discovery, consent management, or tag management. The Feature Matrix lists what each feature includes and what it needs to set up.

What you need

  • A development team that builds with Node.js, TypeScript, and Vue 3.
  • A SCAYLE shop and access to the SCAYLE Panel.
  • A place to run the application, with a Redis-compatible store for sessions and caching. Storefront Hosting is SCAYLE's managed platform and includes the store. You can also run the application in your own containers.
  • An account with a CMS vendor, if your editors manage content pages.

What stays with SCAYLE and what is yours

SCAYLE ships the commerce logic every shop needs, such as basket handling or how a product listing is sorted, as versioned packages. Your team updates them like any other dependency. The code in your fork is yours. Your team can change any file in it, and fixes to the application code do not reach your fork automatically. Architecture Principles explains the thinking behind this split.

How it is built

The Storefront Application V3 runs as one Node.js application. It renders pages with Vue 3 on a Hono server, styles them with Tailwind CSS, uses Inertia.js to send the browser a fully rendered first page, and answers actions such as adding an item to a basket through a type-safe request layer built on oRPC. Your server renders the checkout page, then the SCAYLE Checkout component takes over, so card and payment details go straight to SCAYLE and never reach your server. Tech Stack explains each choice, and Architecture shows how the pieces fit together.

The Storefront Application V3 is licensed under the BSD 3-Clause license, and the SDK packages it builds on are licensed under the MIT license.

Two tools help your team while it builds. The Storefront CLI sets up a project from your shop's data, and Storefront DevTools show the Inertia.js visits, page props, and oRPC calls of each page on your machine. To begin, follow Set Up Your Storefront.