MetatroncubeSoftwareSolutions/metatrondelivery
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update README for Postgres-based local dev and Phase 1 status

Browse Source 
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
metatroncubeswdev 2026-08-23 17:48:19 -04:00
parent 21f0ee704b
commit a35a4f89be
1 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -14,16 +14,14 @@ non-negotiables for AI-assisted work in this repo.
```sh ```sh
npm install npm install
cp .env.example .env # fill in Shopify app credentials after linking cp .env.example .env # fill in Shopify app credentials after linking
npx prisma migrate dev # creates prisma/dev.sqlite locally docker compose up -d # local Postgres (5433) + Redis (6380)
npx prisma migrate dev
npm run dev # shopify app dev — requires `shopify auth login` first npm run dev # shopify app dev — requires `shopify auth login` first
``` ```
Redis must be running locally for slot-holds/BullMQ (Phase 4+): 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`
```sh runs the BullMQ worker (jobs/worker.ts) once Phase 4 makes it do anything.
redis-server # or: docker run -p 6379:6379 redis
npm run worker # BullMQ worker (jobs/worker.ts)
```
## Commands ## Commands
@ -39,5 +37,6 @@ npm run worker # BullMQ worker (jobs/worker.ts)
## Status ## Status
Greenfield — Phase 0 (scaffold & CI) complete. See §6 of Phase 0 (scaffold & CI) and Phase 1 (core data model & admin CRUD) complete.
`IMPLEMENTATION_PLAN.md` for the phased build order and acceptance criteria. See §6 of `IMPLEMENTATION_PLAN.md` for the phased build order and acceptance
criteria — next up is Phase 2 (the scheduling engine).