Files
store/QUICKSTART.md
zeekayandHanzo Dev ee5a2fb3ec The docs described the stack the convergence removed
`README` still said "Modern, responsive interface with Tailwind CSS" and listed
Tailwind under Tech Stack; it also sent readers to :3000 (dev runs on 3200) and
to `data/apps/`, a directory that has been `data/agents/` + `data/tools/` for
some time. Corrected, and the two scripts that verify anything — `typecheck` and
`test:e2e` — are listed with the others.

`STORE_UI.md` is deleted rather than corrected. Every concrete fact in it was
false: a `blue-600` Tailwind palette and a class reference for classes that no
longer exist, "5 apps" against 202, ":3000", "1 static route" against 209, and
app detail pages listed as a FUTURE enhancement three commits after they
shipped. What was still true in it — the breakpoints, the two-vocabulary rule —
is already stated in `globals.css`'s own comments and asserted in the e2e suite,
where it is executable and cannot drift. A second prose copy is how the two
disagree. `QUICKSTART` points at LLM.md in its place.

`LLM.md` was a 2025 audit report carrying `/Users/z/work/shinkai/hanzo-store/`
paths from another machine, ten findings against files that no longer exist
(`types/hanzo-ui.d.ts`, `types/hanzo.d.ts`, `next.config.js`) and issues since
fixed — `sanitizeUrl` is `lib/url-utils.ts`, `ignoreBuildErrors` is gone. It is
now what an agent actually needs before touching this repo: that the catalog
here is the Market's editorial source and not its read path; that the UI is
@hanzo/ui on @hanzo/gui with exactly two vocabularies and no third; that gui
accepts a prop it does not recognise and lets one prop undo another, with the
shapes that bite listed; that verification therefore means reading computed
styles, not building; and why TypeScript stays on 5.x.

@hanzo/ui 8.0.39 → 8.0.40, the version published while this was in progress.

Verified on 8.0.40: `tsc --noEmit` clean; `next build` exports 209 static pages;
`playwright test --project=chromium` 21 passed; and the computed-style probe
still reads card body 125px, the longest description clamped to exactly 3 lines,
panel headings at 600, no underline on any button, and no Tailwind class on the
page.

Co-authored-by: Hanzo Dev <[email protected]>
2026-08-04 17:56:23 -07:00

4.0 KiB

Quick Start - Enable GitHub Pages

🚀 Your Store UI is Ready!

The Next.js store UI is fully built and deployed via GitHub Actions. Just enable GitHub Pages to make it live!

✅ What's Already Done

  • ✅ Next.js store UI with search & filtering
  • ✅ 5 example MCP apps loaded
  • ✅ GitHub Actions workflow configured
  • ✅ Automatic builds on every push
  • ✅ Static site generation (out/ folder)

🎯 Enable GitHub Pages (One-Time Setup)

  1. Go to Settings

    https://github.com/hanzo-apps/store/settings/pages
    
  2. Configure Source

    • Under "Build and deployment"
    • Source: Select "GitHub Actions"
    • Click "Save"
  3. Set Permissions (if deployment fails)

    https://github.com/hanzo-apps/store/settings/actions
    
    • Under "Workflow permissions"
    • Select: "Read and write permissions"
    • Check: "Allow GitHub Actions to create and approve pull requests"
    • Click "Save"
  4. Wait for Deployment

Option 2: CLI (Alternative)

# Enable Pages via API (requires repo admin access)
gh api repos/hanzo-apps/store/pages \
  -X POST \
  -f source[branch]=main \
  -f source[path]=/

🌐 Your Store URL

Once enabled, your store will be available at:

https://hanzoai.github.io/store/

🔗 Custom Domain (Optional)

To use store.hanzo.ai:

  1. Add DNS CNAME Record

    Type:  CNAME
    Name:  store
    Value: hanzoai.github.io
    
  2. Configure in GitHub

  3. Wait for DNS Propagation (5-30 minutes)

🧪 Test Your Store Locally

cd /Users/z/work/hanzo/store

# Development mode
npm run dev
# Visit: http://localhost:3000

# Production build
npm run build
npx serve out
# Visit: http://localhost:3000

📱 Store UI Features

Your store includes:

  • 🔍 Real-time Search - Instant filtering across names, descriptions, tags
  • 📂 Category Filters - Quick browsing by category with counts
  • 📋 Copy Install Commands - One-click copy for easy installation
  • 📱 Responsive Design - Works perfectly on mobile and desktop
  • ⚡ Fast Loading - Static site, no backend required
  • 🔄 Auto-updates - Rebuilds on every push to main branch

📊 Current Store Contents

  • 5 Apps: Example, Filesystem, GitHub, PostgreSQL, Web Search
  • 4 Categories: Development Tools, File Management, Productivity, Data & Analytics
  • JSON API: /store.json for programmatic access

🎯 Next Steps

  1. ✅ Enable GitHub Pages (see above)
  2. ✅ Verify Deployment - Check Actions tab for success
  3. ✅ Visit Store URL - Test all features
  4. 📦 Add More Apps - Submit PRs with new MCP servers
  5. 🎨 Customize - Update styling, colors, branding

📖 Documentation

  • README.md - Full project documentation
  • CONTRIBUTING.md - How to add apps
  • DEPLOYMENT.md - Deployment details
  • LLM.md - the UI stack, and the two things that bite anyone changing it

🆘 Troubleshooting

Deployment Fails

Check workflow permissions:

https://github.com/hanzo-apps/store/settings/actions

Enable "Read and write permissions"

Pages Not Updating

  1. Check workflow logs: https://github.com/hanzo-apps/store/actions
  2. Verify main branch protection allows workflows
  3. Clear browser cache and reload

Build Errors

Run locally to debug:

npm run generate-store
npm run build

Check error messages and fix JSON files if needed.

📞 Support


Your store is production-ready! Just enable GitHub Pages and you're live! 🎉