Shopify App TanStackShopify app primitives rebuilt for TanStack Router

A community-maintained toolkit for authentication, webhooks, API clients, and embedded React app wiring in Vite-based Shopify apps.

Explore the Architecture

Migration Guide

GitHub

🧩

Familiar Shopify Server Primitives

Keep a familiar `shopifyApp(...)` setup with authentication, session handling, webhook verification, and unauthenticated API contexts.

⚡

TanStack Router-Friendly Runtime

Built to pair with TanStack Router patterns while preserving Shopify app behavior for embedded and public routes.

🛡️

Complete Auth Flow Coverage

Includes admin auth, public routes, POS, flow auth, fulfillment-service auth, and webhooks under a single server API surface.

🧪

Test Helper Support

Comes with test helper exports and repository-level fixtures to make integration and e2e testing more straightforward.

🧭

Clear Module Boundaries

Server and React modules are split intentionally to prevent cross-boundary imports and keep bundle behavior predictable.

📦

Vite Ecosystem First

Works naturally in Vite workflows, with typed exports for server, react, and test-helper entrypoints.

Quick start

bun add @yan-ad/shopify-app-tanstack @tanstack/react-router

import {shopifyApp} from '@yan-ad/shopify-app-tanstack/server';

export const shopify = shopifyApp({
  apiKey: process.env.SHOPIFY_API_KEY!,
  apiSecretKey: process.env.SHOPIFY_API_SECRET!,
  scopes: process.env.SCOPES?.split(',')!,
  appUrl: process.env.SHOPIFY_APP_URL!,
  sessionStorage: /* your session storage */ undefined as never,
});

Learn the codebase

Local docs development

bun docs:dev

bun docs:dev -- --port 3030