Skip to content

☁️ Starter Template for Cloudflare Workers with GitHub Actions CI and Automatic Releases

License

Notifications You must be signed in to change notification settings

BetaHuhn/cf-worker-starter

Repository files navigation

☁️ Cloudflare Worker Starter

Node CI Release CI GitHub David

Starter Template for Cloudflare Workers with GitHub Actions CI and Automatic Releases

🚀 Features

⚙️ Setup

  1. Create a new repository from this template
  2. Clone your new repository
  3. Install dependencies using npm install
  4. Update package details in package.json and README.md
    1. Find and replace betahuhn/cf-worker-starter with user/repository
    2. Find and replace @betahuhn/cf-worker-starter with projects npm name
  5. Create a repository secret called CF_API_TOKEN to use the wrangler-action
  6. Specify your worker details in the wrangler.toml file (more info in Cloudflare's Docs)

💻 Available commands

  • run yarn lint or npm run lint to run eslint.
  • run yarn test or npm run test to run all Mocha tests.
  • run yarn dev or npm run dev to run the Worker locally with Wrangler.
  • run yarn build or npm run build to produce a production version with webpack.

❔ About

This project was developed by me (@betahuhn) in my free time. If you want to support me:

Donate via PayPal

ko-fi

📄 License

Copyright 2021 Maximilian Schiller

This project is licensed under the MIT License - see the LICENSE file for details.