- TypeScript 29.4%
- Vue 27.1%
- JavaScript 25.4%
- CSS 13.3%
- HTML 2.5%
- Other 2.3%
| .agents/skills/update-changelog | ||
| .github/workflows | ||
| functions | ||
| public | ||
| src | ||
| worker | ||
| .browserslistrc | ||
| .editorconfig | ||
| .envrc | ||
| .eslintignore | ||
| .gitignore | ||
| AGENTS.md | ||
| babel.config.js | ||
| CHANGELOG.md | ||
| flake.lock | ||
| flake.nix | ||
| index.html | ||
| jsconfig.json | ||
| Justfile | ||
| Makefile | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| renovate.json | ||
| VERSION | ||
| vite.config.mjs | ||
| wrangler.toml | ||
rfd-fyi
This repository provides a simple, less-distracting frontend for Hot Deals posted on https://forums.redflagdeals.com.
The frontend is a Vite/Vue 3 app. Cloudflare Pages serves the static output, Pages Functions serve /topics.json, /html, and /admin/refresh from Cloudflare KV, and a scheduled Cloudflare Worker refreshes cached topics to avoid excessive requests to RedFlagDeals itself.
Architecture
flowchart TD
Browser[Browser] -->|GET /| Pages[Cloudflare Pages static assets]
Browser -->|GET /topics.json| TopicsFn[Pages Function: /topics.json]
Browser -->|GET /html| HtmlFn[Pages Function: /html]
TopicsFn -->|read topics.json| KV[(Cloudflare KV: TOPICS_KV)]
HtmlFn -->|read topics.json| KV
Cron[Cloudflare Cron Trigger<br/>every 5 minutes] --> RefreshWorker[Scheduled Worker: rfd-fyi-refresh]
RefreshWorker -->|fetch topic pages| RFD[RedFlagDeals API]
RefreshWorker -->|fetch redirect rules| Redirects[Redirect rules JSON]
RefreshWorker -->|write topics.json| KV
AdminPages[Manual refresh<br/>POST /admin/refresh] --> TopicsRefreshFn[Pages Function: /admin/refresh]
AdminWorker[Manual refresh<br/>GET /refresh] --> RefreshWorker
TopicsRefreshFn -->|fetch topic pages| RFD
TopicsRefreshFn -->|fetch redirect rules| Redirects
TopicsRefreshFn -->|write topics.json| KV
Cloudflare deployment
Install dependencies and log in to Cloudflare:
npm ci
npx wrangler login
Create a KV namespace and a preview namespace:
npx wrangler kv namespace create TOPICS_KV
npx wrangler kv namespace create TOPICS_KV --preview
Copy the returned namespace IDs into both:
wrangler.tomlworker/wrangler.toml
Build and deploy the Pages app:
npm run build
npm run pages:deploy
# or
npm run build && just deploy-pages
Deploy the scheduled refresh Worker:
npm run worker:deploy
# or
just deploy-worker
Deploy both:
just deploy
The Worker runs every 5 minutes and writes the latest topics to KV. Pages reads that cached JSON at /topics.json and renders a no-JavaScript view at /html.
Optional manual refresh endpoints:
# For the Pages /admin/refresh endpoint
npx wrangler pages secret put REFRESH_SECRET --project-name rfd-fyi
curl -X POST -H "Authorization: Bearer $REFRESH_SECRET" https://<your-pages-domain>/admin/refresh
# For the Worker /refresh endpoint
npx wrangler secret put REFRESH_SECRET --config worker/wrangler.toml
curl -H "Authorization: Bearer $REFRESH_SECRET" https://rfd-fyi-refresh.<your-subdomain>.workers.dev/refresh
Tests and checks
Run the unit test suite:
npm test -- --run
Run coverage:
npm run test:coverage -- --run
Run linting and a production build:
npm run lint
npm run build
GitHub Actions runs npm ci, tests, linting, and build on every push and pull request.
Local Development
Full Cloudflare Pages local dev
Run the Cloudflare Pages build locally, including Pages Functions:
npm run pages:dev
Wrangler serves the app at:
http://localhost:8788
Local Pages KV starts empty, so the app may initially show no deals. Seed local KV by calling the manual refresh endpoint in another shell:
curl -X POST -H "Authorization: Bearer dev" http://localhost:8788/admin/refresh
A successful refresh returns something like:
{"refreshed":1000}
After that, these local endpoints should return populated data:
http://localhost:8788/topics.json
http://localhost:8788/html
Refresh Worker local dev
To run the scheduled refresh Worker locally:
npm run worker:dev
Frontend-only Vite dev
For frontend-only Vite development:
npm run serve
The Vite dev server proxies /topics.json and /html to the configured production Pages origin by default, so it should show live deals without seeding local KV. Override with VITE_API_ORIGIN if needed:
VITE_API_ORIGIN=http://localhost:8788 npm run serve