Imported from github.com/cyguin/npm-suite-demo
Find a file
2026-06-03 17:36:22 -07:00
src fix #1: add vitest test suite 2026-05-20 13:20:25 -07:00
.gitignore gsd: pre-implementation lint/format cleanup 2026-05-16 07:42:43 -07:00
index.html gsd: pre-implementation lint/format cleanup 2026-05-16 07:42:43 -07:00
lefthook.yml chore: add lefthook pre-commit hooks 2026-06-03 17:36:22 -07:00
LICENSE Refresh cyguin packages and demo skin 2026-04-21 09:21:38 -05:00
package-lock.json fix #1: add vitest test suite 2026-05-20 13:20:25 -07:00
package.json fix #1: add vitest test suite 2026-05-20 13:20:25 -07:00
README.md gsd: pre-implementation lint/format cleanup 2026-05-16 07:42:43 -07:00
tsconfig.json Initial npm suite demo 2026-04-21 04:39:43 -05:00
vite.config.ts fix #1: add vitest test suite 2026-05-20 13:20:25 -07:00

@cyguin/npm-suite-demo

Standalone showcase app for the cyguin npm suite.

This repo demonstrates the public React-facing packages in one cyguin-branded Vite app. It uses in-browser mock API endpoints so the widgets can fetch, submit, dismiss, and update state without a database or backend service.

Packages

Package Demo surface
@cyguin/waitlist Waitlist form with demo count and admin data
@cyguin/notify Notification bell with unread state
@cyguin/announce Dismissible announcement banner
@cyguin/banner Consent banner
@cyguin/feedback Thumbs, rating, and text feedback widgets
@cyguin/survey Post-action micro-survey modal
@cyguin/docs Searchable docs widget
@cyguin/sniplet Snippet create and view workflow
@cyguin/changelog-react Changelog badge and release feed
@cyguin/claude-context-gen CLI workflow preview

Quick Start

npm install
npm run dev

Open http://127.0.0.1:5173.

Scripts

Command Description
npm run dev Start the Vite dev server
npm run build Type-check and build the production bundle
npm run preview Preview the production bundle locally

Mock API

The demo installs a browser fetch shim from src/mockApi.ts. It handles the suite routes used by the mounted components:

  • /api/waitlist
  • /api/notify
  • /api/announce
  • /api/banner
  • /api/feedback
  • /api/docs
  • /api/changelog
  • /api/snips
  • /api/survey

This keeps the repo self-contained while still exercising the same request paths the packages expect in a real app.

License

MIT. See LICENSE.