Skip to content

Minimal starter for building a new Cloudflare Workers project 🦕

Notifications You must be signed in to change notification settings

denis-avakov/worker-typescript-template

Repository files navigation

worker-typescript-template 🦕

This is a minimal starter for building a new Cloudflare Workers project that uses TypeScript, Hono, Miniflare, esbuild and Vitest. Use this boilerplate to build your new best thing ヾ(๑╹◡╹)ノ"

Maintainability Test Coverage Test

How to use

  1. Rename the wrangler.example.toml to wrangler.toml and populate the variables
  2. Run pnpm run dev in your terminal to start a development server
  3. Open a browser at http://127.0.0.1:8787/ to see your worker in action
  4. Make HTTP requests to /cdn-cgi/mf/scheduled to trigger scheduled events

Lern more

CLI

# Install dependencies
$ pnpm install

# Start local development server with live reload
$ pnpm run dev

# Start remote development server using wrangler
$ pnpm run dev:remote

# Run tests
$ pnpm run test

# Run coverage test report
$ pnpm run coverage

# Deploy using wrangler
$ pnpm run deploy