Documentation / Onboarding

Quick Start Checklist

A tick-box execution list from licence check to compliance close-out. Work through each phase in order — every item here is covered in more depth by its matching guide.

6 min read

Before you start

License ID received and recorded

Purchase email confirmed

Node.js 20.19–21 or 22.12+ installed (node -v)

Shopify Partner account and a development store created

Get the package

Source code package downloaded from the secure link in your delivery email

Package unpacked to a folder you'll remember

The original release zip archived somewhere safe for future upgrades

Local installation

Dependencies installed (npm install)

.env created from .env.example and filled in

Database migrated (npm run setup)

Dev server running (npm run dev) with no startup errors

npm run lint and npm run typecheck both pass on the untouched checkout

Shopify Partner setup

Codebase linked to your Partner app (npm run config:link)

.env's SHOPIFY_API_KEY / SHOPIFY_API_SECRET / SCOPES match the Partner app

App installs on your dev store and prompts for the expected scopes

The storefront block appears in the Theme Editor's app block picker after npm run deploy

A test quote submitted from the storefront reaches the app

Database setup

Hosted PostgreSQL database created

Connection string set as DATABASE_URL

npm run setup completes with no errors

Session and Quote tables visible via Prisma Studio or your database console

Deployment

App installs successfully on a real store pointed at the target environment

Embedded admin loads without redirect loops or auth errors

application_url, redirect_urls, and app_proxy.url all resolve over HTTPS

A test quote reaches the app through the App Proxy

Outbound emails send successfully

npx prisma migrate status reports no pending migrations

All five webhooks visible/registered in the Partner Dashboard

TIP

If any item above doesn't check out, look it up in Troubleshooting before contacting support — most setup issues are answered there directly.

Compliance close-out

The licence obligations stay with you, the licence holder — even if an implementation partner did the technical work. Confirm each of these before considering the rollout complete.

License Agreement PDF downloaded and archived

Production Deployment count confirmed within your licensed limit (1)

Non-Production Deployment count confirmed within your licensed limit (up to 3)

Update & Support Term start date noted

Renewal date calendared, ahead of the Update & Support Term expiry

Everything, Documented