metatroncubeswdev 039b1539ab docs: update README for Phase 3 completion
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-08-23 18:02:47 -04:00

Delivery Date & Time

Shopify app: scheduling for Shipping / Local Delivery / Store Pickup, with date-time slots, capacity intelligence, and all-plan checkout enforcement via Cart/Checkout Validation Functions.

Read PRODUCT_STRATEGY.md (why) and IMPLEMENTATION_PLAN.md (how, phased build order) before making changes. CLAUDE.md holds the non-negotiables for AI-assisted work in this repo.

Getting started

npm install
cp .env.example .env        # fill in Shopify app credentials after linking
docker compose up -d        # local Postgres (5433) + Redis (6380)
npx prisma migrate dev
npm run dev                 # shopify app dev — requires `shopify auth login` first

Dev uses Postgres, same as prod, since the schema relies on Prisma enums and (from Phase 5 on) array fields that SQLite can't express. npm run worker runs the BullMQ worker (jobs/worker.ts) once Phase 4 makes it do anything.

Commands

Command Purpose
npm run dev shopify app dev — local dev against a dev store
npm test Vitest unit tests
npm run test:e2e Playwright E2E
npm run lint / npm run typecheck ESLint / tsc --noEmit
npx prisma migrate dev DB migrations
npm run deploy shopify app deploy — deploy extensions/functions
npm run worker BullMQ worker (hold-expiry, notifications)

Status

Phase 0 (scaffold & CI), Phase 1 (core data model & admin CRUD), Phase 2 (scheduling engine), and Phase 3 (storefront widget + cart attributes — extensions/datetime-widget/) are complete. See §6 of IMPLEMENTATION_PLAN.md for the phased build order and acceptance criteria — next up is Phase 4 (enforcement Functions + slot-holds).

Editing the storefront widget's extensions/datetime-widget/src/? Run npm run build:widget to rebuild assets/datetime-widget.js — it also runs automatically before npm run dev / npm run deploy.

Description
No description provided
Readme 1.7 MiB
Languages
TypeScript 86.7%
JavaScript 9.2%
Liquid 3%
CSS 1%
Dockerfile 0.1%