Documentation

Quick Start

Get your store live in 5 minutes.

Installation

Clone, configure, and deploy locally.

Architecture Overview

Understand the edge-native multi-tenant design.

Environment Variables

Complete reference for all .dev.vars values.

Authentication

JWT-based auth, refresh tokens, tenant users.

Products

Create and manage products, variants, images.

Orders

Order lifecycle, fulfillment, cancellation.

Storefront API

Public APIs for building custom storefronts.

Webhooks

Configure and test outgoing webhooks.

Discounts

Coupon codes, percentage and fixed discounts.

Cloudflare Workers

Deploy the API to Cloudflare Workers.

Cloudflare Pages

Deploy frontend apps to Cloudflare Pages.

D1 Migrations

Apply database migrations to staging and production.

CI/CD with GitHub Actions

Automated deploy on push to main.

Custom Storefront

Build a headless storefront using the public API.

Multi-Tenant Architecture

How tenant isolation works at the data layer.

Adding a Custom Domain

Connect shop.yourdomain.com to your storefront.

Media & Uploads

Upload images and videos to Cloudflare R2.