Skip to main content

​
Theme Development

A Shoppex theme is a standalone frontend app that renders a storefront UI. You can choose the UI framework:
  • React
  • Vue
  • Svelte
  • Anything else that can build to static files
But a few things are fixed by the Shoppex platform:
  • Themes are built with a Vite-style build pipeline
  • The build output must be a dist/ folder with dist/index.html and assets
  • Themes use the Shoppex Storefront SDK for data (store, products, cart, checkout handoff)
If you want to build themes with Vue/Svelte/etc: totally fine. Just keep the build contract the same (bun run build → dist/).

​
Theme vs SDK (one sentence)

Theme = UI/UX. SDK = data + cart + checkout behavior.

​
Choose Your Path

Quickstart

Run a theme locally in minutes. No backend required (Public API track).

Core Contract

The framework-agnostic rules your theme must satisfy (dist output, build scripts, initial data injection).

Build Pipeline

How Shoppex builds, injects initial data, and deploys your theme to the edge.

​
Reference Theme In This Repo

Our reference implementations are Vite + React:
  • themes/default
  • themes/classic
If you want to understand how things work in practice, start with:
  • themes/default/src/main.tsx
  • themes/default/index.html

​
Source Of Truth (Architecture)

If you need the “big picture”:
  • the theme contract is documented here under Core Contract, Runtime & SDK, and Build Pipeline
  • the serving infrastructure is intentionally described at a high level (implementation details may change)