mirror of
https://github.com/saphid/frame-control.git
synced 2026-10-06 12:00:37 +02:00
saphidandClaude Opus 5.5
7d328e20a5
- site/: landing page, /feedback/ and /privacy/ on Cloudflare Pages (frame-control.pages.dev). POST /api/feedback validates the form and opens a labelled issue with a fine-grained token; honeypot, minimum fill time and KV rate limits keep spam out. Ko-fi donate buttons appear once the page name is set in site/public/js/site.js. - .github: the issue and PR gate from badlogic/pi-mono. New contributors' issues and PRs are auto-closed; a maintainer replying lgtmi/lgtm approves them via APPROVED_CONTRIBUTORS. Issue templates and CONTRIBUTING.md. - CI runs the website tests; README points feedback at the form. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
36 lines
1.6 KiB
Markdown
36 lines
1.6 KiB
Markdown
# Website
|
|
|
|
The Frame Control website, <https://frame-control.pages.dev>, on Cloudflare Pages.
|
|
|
|
- `public/`: static pages. `/` is the landing page, `/feedback/` the feedback form, `/privacy/` the privacy note.
|
|
- `functions/api/feedback.js`: `POST /api/feedback`, which turns the form into a GitHub issue labelled `feedback`.
|
|
- `lib/feedback.js`: validation and issue formatting, tested by `test/feedback.test.mjs`.
|
|
- `public/js/site.js`: settings, including the Ko-fi page name for the donate buttons.
|
|
|
|
## Feedback → GitHub issues
|
|
|
|
The function needs a `GITHUB_TOKEN` secret: a fine-grained token with **Issues: read and write** on
|
|
`saphid/frame-control` only. Issues are opened as the token's owner, so they pass the contributor gate
|
|
(`.github/workflows/issue-gate.yml`) and stay open. Without the token the form answers 503 and offers a
|
|
prefilled GitHub issue instead.
|
|
|
|
```sh
|
|
cd site
|
|
npx wrangler pages secret put GITHUB_TOKEN --project-name frame-control
|
|
```
|
|
|
|
Spam protection: a hidden honeypot field, a 3-second minimum fill time, 5 submissions per hour per IP
|
|
(a salted hash, kept in the `FEEDBACK_RL` KV namespace for about an hour), and 100 a day in total.
|
|
User text has `@mentions` and `#123` references broken so nobody gets pinged.
|
|
|
|
## Run and deploy
|
|
|
|
```sh
|
|
cd site
|
|
node --test test/*.test.mjs
|
|
npx wrangler pages dev --port 8788 # local; put GITHUB_TOKEN/GITHUB_REPO in .dev.vars to test issues
|
|
npx wrangler pages deploy --branch main # production
|
|
```
|
|
|
|
Point `GITHUB_REPO` in `.dev.vars` at a scratch repo when testing locally so test issues don't land on the real tracker.
|