Docs/Getting Started

Getting Started

ThemeSync is a theme ops platform for Shopify and WooCommerce agencies. Learn how the app is organised, what the core concepts mean, and how everything fits together.

What is ThemeSync?

ThemeSync replaces the scattered tools agencies use to ship themes — staging servers, BrowserStack, Loom videos, email chains, and spreadsheets — with a single platform that connects to your client's store directly.

☁

Cloud Preview

Run your dev theme in the cloud. Share a preview URL — clients see the design on their live store with no code access.

📷

Visual QA

Automated cross-browser screenshots across 5 devices and 4 browser engines including real Safari.

💬

Client Feedback

Clients drop pin comments on the live preview. No login needed. Approvals tracked per page and role.

👥

Team Workflow

Designer, QA, PM, and Client roles each sign off independently. Nothing ships without full approval.

Core Concepts

Stores

A store is a connected Shopify store or WooCommerce site — usually one client. Store-level credentials (Admin API token, Theme Access password) are saved once and shared across all themes on that store.

Themes

A theme is one version of work connected to a store. A store can have many themes at once:

  • Development theme — runs the Shopify CLI in the cloud with a live-reload dev server.
  • Production theme — tracks a live or draft Shopify theme in git without a dev server. Shopify → git syncs automatically.

Workspaces

Your workspace is your agency account. It holds all your stores, themes, team members, and billing. Team members see all stores in the workspace but can only approve within their assigned role.

App Layout

ThemeSync uses a two-rail layout designed so you never lose context when switching between clients or features.

The ThemeSync app: the store switcher on the far left, the theme navigation next to it, the main content area, and the console dock along the bottom.
Store switcher, theme navigation, main area and console dock
Rail 1 — Store Switcher

Always-visible narrow column on the far left. Each connected store is an avatar button. Click to switch stores. A warning dot shows if a store needs attention.

Rail 2 — Theme Nav

When inside a theme: Overview, Templates, QA & Screenshots, Feedback, Performance, Settings. In workspace sections (Team, Billing): account navigation instead.

Store Home

The main area when no theme is open. Shows the live theme as a hero card, then Draft themes, then Development themes — for the selected store.

Console Dock

A collapsible strip at the bottom. Shows real-time Shopify CLI output for the active dev theme. Persists across navigation.

Top Bar

Workspace name, dark/light mode toggle, and account menu.

Bookmarkable URLs Every theme and tab has a stable URL — e.g. /acme-store/my-theme/qa. Share links directly to any view.

Connecting a Store

Click the + button in Rail 1 or Add Theme on the store home to open the new theme flow. You'll choose a platform (Shopify or WooCommerce), enter the store URL, and optionally add credentials and a git repo.

First time? Follow the Quick Start guide for a step-by-step walkthrough from zero to your first QA scan.

Shopify vs WooCommerce

FeatureShopifyWooCommerce
Preview methodShopify native theme preview URLPlugin swaps theme per visitor
Dev environmentFull Shopify CLI, live-reload, terminalGit-push deploys + CDN delivery
Production trackingAuto-sync live/draft themes to gitNot applicable (always push-based)
AuthBrowser OAuth or Theme Access passwordWP Application Passwords
TemplatesLiquid files, auto-detectedPHP files, scanned from theme
QA screenshotsVia dev server or production URLVia live site + preview token

Git Integration

Connect any HTTPS git repo — GitHub, GitLab, Bitbucket, or self-hosted. ThemeSync clones it, checks out your branch, and syncs on a configurable interval.

Supported providers

  • GitHub — Personal Access Token (PAT) with repo scope
  • GitLab — Project or Personal Access Token
  • Bitbucket — App Password with repository read access
  • Any HTTPS git host — embed credentials in the URL or use a token
Encrypted at rest Tokens are encrypted before storage and never displayed again after saving.

Sync intervals

IntervalBest for
OffManual pull only
30 sActive development — near-instant updates
1 minDefault — good balance
5 minStaging or low-activity branches

For production themes, sync runs in the opposite direction: Shopify → git. See Production Tracking.