Skip to content

Latest commit

 

History

History
25 lines (17 loc) · 1.8 KB

AGENTS.md

File metadata and controls

25 lines (17 loc) · 1.8 KB

Instructions for StarTune

A self-hosted Cloudflare Worker (Hono, worker/) serving a React app (src/) that helps a GitHub user organise their stars and watch their own repos. shared/ is imported by both sides, so it stays free of Worker and DOM APIs.

  • Product decisions and copy: read PRODUCT.md.
  • UI changes: read DESIGN.md first, and update it in the same change when you add or alter a component or pattern.

Data

  • Each Backend method (src/lib/api.ts) also has a demo version in src/lib/demo.ts or demo-own.ts. It returns plausible generated data and never calls GitHub.
  • Each schema change is a new file in migrations/; applied migrations stay unchanged.
  • The cron cleanup in worker/cron.ts deletes repos no table references. A new table that references repos joins its exemption list.

Verifying

  • Check UI changes in a browser in demo mode (/?demo=1, no GitHub login needed) at 1440 and 390 wide. Signed-in paths need a real token; say when one went untested.
  • Screenshots for docs and PRs come from demo mode only.
  • If the dev server serves a blank page after a vite.config.ts change, restart it.

Conventions

  • A push to main deploys to production, so each push bumps version in package.json (semver: patch for fixes, minor for features).
  • Allow a deliberate lint exception with a file override in .oxlintrc.json whose comment gives the reason.
  • vite.config.ts resolves its root and aliases to the on-disk path so a build started from c:\ or C:\ bundles each module once (otherwise two React Query copies and "No QueryClient set" on every page).
  • The logo mark is defined in src/components/shell.tsx and brand/make_logo.py, which also writes the favicon, app icons and web manifest into public/. Change both, then re-run the script (brand/README.md).