Open-source, self-hosted ecommerce with Shopify-class storefront and admin.
| I want to… | Start here |
|---|---|
| Understand the project (2 min) | brief.md |
| Why we built it this way | philosophy.md |
| Full technical thesis | whitepaper.md |
| Run locally first time | onboarding.md |
| Daily dev workflow | local-development.md |
| Contribute | ../CONTRIBUTING.md |
| Rebrand / fork | customization.md |
| Leave Shopify | migration-from-shopify.md |
| Ship to production | deployment.md → release-checklist.md |
| Operate live store | runbook.md |
| Debug something | troubleshooting.md · faq.md |
| One-screen lookup | quick-reference.md |
| Storefront release gate | storefront-release.md |
| All four protocols | protocols.md |
STRATEGY BUILD SHIP
──────── ───── ────
brief.md architecture.md deployment.md
philosophy.md protocols.md release-checklist.md
whitepaper.md flows.md runbook.md
platform-overview.md data-model.md security.md
api-overview.md testing.md
START SURFACES POLICY
───── ──────── ──────
onboarding.md storefront.md commerce-protocol-frozen.md
day-2.md storefront-release.md checkout.md
local-development.md admin.md inventory.md
getting-started.md concierge/overview.md refunds.md
environment-variables.md CONTRIBUTING.md (repo root)
contributing-commerce.md
REFERENCE
─────────
glossary.md · faq.md · quick-reference.md · customization.md
migration-from-shopify.md · troubleshooting.md
| When | Docs |
|---|---|
| Day 0 | onboarding.md, getting-started.md, environment-variables.md |
| Daily | local-development.md, quick-reference.md |
| Learning | architecture.md, flows.md, protocols.md |
| PR | CONTRIBUTING.md, contributing-commerce.md, testing.md, release-checklist.md |
| When | Docs |
|---|---|
| First login | onboarding.md § Operator |
| Daily tasks | admin.md § Cookbook |
| From Shopify | migration-from-shopify.md |
| Rebrand | customization.md |
| When | Docs |
|---|---|
| Deploy | deployment.md, release-checklist.md |
| Operate | runbook.md |
| Incidents | troubleshooting.md |
| Security | security.md |
| Doc | Summary |
|---|---|
| admin.md | Merchant console + operator cookbook |
| api-overview.md | HTTP route map |
| architecture.md | Layers, diagrams, entities |
| checkout.md | Money capture protocol |
| commerce-protocol-frozen.md | Mutation policy |
| concierge/overview.md | AI support |
| CONTRIBUTING.md | Contribution guide |
| contributing-commerce.md | Safe commerce extension guide |
| customization.md | Rebrand + UI fork guide |
| data-model.md | Firestore collections |
| day-2.md | Post-setup week 1 |
| deployment.md | Production deploy |
| environment-variables.md | Full env reference |
| faq.md | Common questions |
| flows.md | End-to-end stories |
| getting-started.md | Setup reference |
| glossary.md | Terms |
| inventory.md | Stock protocol |
| local-development.md | Dev workflow + debugging |
| migration-from-shopify.md | Shopify migration map |
| onboarding.md | Day-0 guided path |
| platform-overview.md | Scope vs Shopify |
| protocols.md | Four protocols unified |
| quick-reference.md | Cheat sheet |
| production-readiness.md | Deploy gate, health endpoint, rollback |
| operator-commerce-runtime.md | Operator runtime model |
| commerce-incident-runbook.md | Commerce incident response |
| refunds.md | Money reversal protocol |
| release-checklist.md | Pre-release gate |
| runbook.md | Production ops |
| security.md | Auth, secrets, rules |
| storefront.md | Customer shop |
| storefront-release.md | Frozen storefront proof ladder |
| testing.md | Test suites |
| troubleshooting.md | Symptom fixes |
npm test
npm run test:storefront-release # catalog → payment proofs (125 tests)
npm run test:e2e:checkout-smoke # mocked checkout browser smoke
npm test -- --run src/tests/*-verification-ladder.test.ts
npm test -- --run src/tests/protocol-guard.test.ts
npm test -- --run src/tests/production-readiness.test.ts
npm run test:e2etesting.md · storefront-release.md · release-checklist.md
- checkout-protocol-frozen.md → commerce-protocol-frozen.md
- woodbine-crm-whitepaper.md → whitepaper.md