ZShip TanStack
Back to docs

Documentation

Quick start

Run the template locally, connect backend fallbacks, and verify the core flows.

Article
PreviousNext

Use the workspace filter from the repo root:

pnpm --filter @zship/web-tanstack dev
pnpm --filter @zship/web-tanstack check
pnpm --filter @zship/web-tanstack build

The dev server runs on port 4328.

Local backend fallback

Production uses Cloudflare Service Bindings. Local development can use fallback URLs from the Worker environment:

  • AUTH_SERVICE_URL
  • PAY_SERVICE_URL
  • SUPPORT_SERVICE_URL
  • BLOG_SERVICE_URL
  • CHECKIN_SERVICE_URL
  • AI_SERVICE_URL
  • CDN_SERVICE_URL
  • SITE_SERVICE_URL
  • PROMPT_SERVICE_URL
  • PROVIDER1_SERVICE_URL
  • ENTERPRISE_BILLING_SERVICE_URL
  • ZSHIP_KEY

When a Service Binding is unavailable, the proxy layer calls the fallback URL and attaches x-zship-key only for the HTTP fallback path.

First smoke path

  1. Open / and confirm the manifest brand renders.
  2. Open /pricing and confirm plan data loads from the payment service.
  3. Register or sign in through /login or /auth/register.
  4. Open /dashboard and confirm session, credits, orders, and subscription sections render.
  5. Create an API key in /dashboard/keys.
  6. Open /dashboard/tickets (or legacy /support) and create a test ticket if support is enabled.
  7. Open /dashboard/ai-playground and confirm models/config load from the AI service.
  8. Open /sitemap.xml, /robots.txt, and /llms.txt and confirm public URLs are listed.