Skip to content

README.md

Latest commit

 

History

History
76 lines (52 loc) · 1.71 KB

README.md

File metadata and controls

76 lines (52 loc) · 1.71 KB

Counter API

Cloudflare Worker for the 1mb community counter.

Endpoints

Method Path Description
GET / Returns { count: number }
POST / Increment count (1 per IP per 24h)
GET /health Service health status

Setup

1. Login to Cloudflare

npx wrangler login

2. Set secrets

npx wrangler secret put UPSTASH_REDIS_REST_URL --config workers/wrangler.toml
npx wrangler secret put UPSTASH_REDIS_REST_TOKEN --config workers/wrangler.toml

3. Deploy

npm run worker:deploy

Commands

npm run worker:dev      # local development server
npm run worker:deploy   # deploy to production
npm run worker:tail     # view live logs

Testing

npm test              # run test suite
npm run test:watch    # run in watch mode

Tests use @cloudflare/vitest-pool-workers to run the worker in a local Cloudflare runtime with mocked Redis (via fetchMock).

CI/CD

Worker deployment is automated via GitHub Actions (.github/workflows/deploy-worker.yml). Pushes to main that modify workers/** trigger:

  1. Test — runs npm test
  2. Deploy — deploys via wrangler-action@v3

Setup: Add CLOUDFLARE_API_TOKEN as a repo secret. Create the token at the Cloudflare dashboard with "Workers Scripts: Edit" permission.

Production

Architecture

Client (1mb.dev)
    ↓
Cloudflare Worker (counter.js)
    ↓
Upstash Redis (managed)
  • Rate limiting: 1 vote per IP per 24h (IP is hashed, not stored)
  • Offline fallback: Client shows "—" if API unavailable