Skip to main content

Local Setup

Prerequisites​

  • Node.js 24 (.nvmrc)
  • Shopify Admin API tokens for the production and staging stores

Install and run​

npm install
cp .env.example .env # fill in values; see Integrations for what each one enables
npm run dev # starts the service on port 8080

Only NODE_ENV and the four Shopify store variables are required. Every other integration stays off until its variables are set.

Run a job​

Jobs run directly from source with tsx:

npx tsx src/jobs/sync-products.ts --handle=my-product --dry-run
npx tsx src/jobs/sync-collections.ts --handle=summer-sale --dry-run

A local run writes to the real staging store. Start with --dry-run, which lists what would change without writing.

Checks​

npm test
npm run typecheck
npm run biome