Repository navigation
Redesign the README: dashboard walkthrough, verified heuristics and honest status - #4
Merged
Merged
Conversation
- Add a banner, a two-step dashboard walkthrough and a flow card in docs/readme, captured from a local production build - Describe the demo seed, the six heuristics and their fixed assumptions as the code implements them - Say plainly that Deploy Fix is a scripted preview and that only POST /api/shopify/discount can reach Shopify, when configured - Drop the MIT badge and section (there is no LICENSE file), the edge runtime and live-store claims, and the unverifiable revenue figures Co-Authored-By: Claude Opus 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_01TZhsuWjATuivuiFYJGpbY5
- List SHOPIFY_STORE_URL and SHOPIFY_ACCESS_TOKEN with comments, no values - Un-ignore .env.example, which the .env* rule would otherwise hide Co-Authored-By: Claude Opus 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_01TZhsuWjATuivuiFYJGpbY5
Co-Authored-By: Claude Opus 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_01TZhsuWjATuivuiFYJGpbY5
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
- LICENSE: MIT, Copyright Operator Uplift, the license the owner's other public repositories use - README: a license badge, and the footer now says what it covers - package.json: the license field, where the repo has one Co-Authored-By: Claude Opus 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_01TZhsuWjATuivuiFYJGpbY5
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
The README now follows the house style of the allowance pilot, and every claim in it was checked against the code. Several claims in the old README did not hold up:
marginAnalyzer.ts. The table now has the exact triggers, the per-SKU MEDIUM alerts from heuristic 1, and what each heuristic proposes. On the demo seed they produce 10 cards..env.example) and acurlexample for the discount route. The API routes, the Mermaid diagram (corrected) and the repository layout moved into collapsible sections.Removed or corrected, and why:
src/lib/mockShopifyData.ts, a seed built to trigger all six heuristics.executeActioninsrc/app/page.tsxplays timed log lines, shows a client-built payload and appends "200 OK, Discount code is now live in Shopify" without making any request. The realdiscountCodeBasicCreatecall lives inPOST /api/shopify/discount, which nothing in the UI calls.Fixes (separate commits):
.env.examplewithSHOPIFY_STORE_URLandSHOPIFY_ACCESS_TOKEN, with comments and no values. Added!.env.exampleto.gitignore, because the.env*rule would otherwise hide the file.description,homepageandrepositorytopackage.json. The package namehackathon-1was left as it is.All images live in
docs/readme/(five PNGs, about 0.72 MB). They were captured from a local production build (pnpm build, thennext start) with the bundled demo data.Checks
pnpm install --frozen-lockfile: installed. pnpm ignored themswbuild script, as configured.pnpm exec tsc --noEmit: passed. I re-ran it after thepackage.jsonchange.pnpm build: passed (Next.js 16.2.1, Turbopack). It produced 11 static pages, including/and/landing, plus 6 dynamic API routes.pnpm lint: failed with 2 errors and 3 warnings, which I did not fix because the fixes change component behavior. Both errors arereact-hooks/set-state-in-effect, atsrc/app/page.tsx:269andsrc/components/ui/animated-grid-pattern.tsx:90. The warnings are two missinguseCallbackdependencies (AUDIT_LOG_LINES,EXEC_LOG_STEPS) and an unused variable atsrc/app/page.tsx:2228.Observed in the product, not changed
These are product behavior, so they are left for you:
src/app/globals.csssets--font-sans: var(--font-sans);, which references itself. The Geist font fromlayout.tsxis therefore never applied, and the dashboard renders in the browser's default serif (visible in the screenshots). The one-line fix is--font-sans: var(--font-geist-sans);./api/shopify/discountand show itssourcefield.customerGets.items: { all: true }, so the "Dead Stock Clearance" code covers every product, not just the flagged SKU. The title and code are also interpolated straight into the GraphQL string, so a quote in a product title breaks the mutation. GraphQL variables would fix both.public/still has the unused create-next-app SVGs (file,globe,next,vercel,window).Suggested repository settings
These live outside the code, so they are not in this PR:
Margin Protector AI: a Shopify profit-leak audit dashboard with six deterministic margin heuristics and the math behind every fix. Next.js 16, React 19, Tailwind CSS 4.shopify-admin-apianddashboard.docs/readme/banner.png(2400 × 1200) under Settings → General → Social preview.Update: license added
This PR now also adds an MIT
LICENSE(Copyright Operator Uplift), the license the owner's other public repositories use (allowance, cold, UI, webview). The README shows a license badge, the footer says what the license covers, andpackage.jsondeclares it. This is what the original README's MIT badge already claimed, now backed by a real file. This resolves the missing-license note above.https://claude.ai/code/session_01TZhsuWjATuivuiFYJGpbY5
Generated by Claude Code