Skip to main content

​
Quickstart

Goal: run a theme locally without running the Shoppex backend locally.
Recommended setup for external theme devs: run the theme on localhost, fetch real data from https://api.shoppex.io.
If your real goal is “use Claude Code or Codex to customize my theme”, start with Build and Customize a Theme with AI and come back here if you need a local theme running first.
If you already have a hosted Shoppex theme and want to pull it locally, edit it, and push it back, do not start here. Start with Hosted Theme Sync.

​
Step-By-Step

1

Pick a reference theme

In this repo you can start with:
  • themes/default
  • themes/classic
2

Start the dev server

Choose one option below (Public API vs mocks vs local backend).
3

Verify it loads

You should see store info and products. If you use mocks, you should see mock data.

​
Options

​
Next Steps

Build with AI

Beginner-friendly guide for using Claude Code or Codex to inspect, edit, preview, and publish theme changes.

Hosted Theme Sync

Pull a hosted theme locally, edit it in your own tools, and push validated draft changes back.

Local Development

Learn how slug resolution and VITE_API_BASE_URL behave on localhost.

Runtime & SDK

Initialize the SDK, fetch storefront data, and resolve shops by domain.

Editing Themes

The unified workflow for how Shoppex edits, validates, previews, and publishes themes.

AI Workflows

Advanced AI workflow patterns with CLI and MCP after the beginner path.