Skip to content

Latest commit

 

History

History
28 lines (16 loc) · 1.63 KB

README.md

File metadata and controls

28 lines (16 loc) · 1.63 KB

cf-workers-base

A template repository (of sorts) for basing my future Cloudflare Workers projects off of. Note: This based on Typescript and does not have any built-in testing

🔋 Getting Started

This template is meant to be used with Wrangler. If you are not already familiar with the tool, we recommend that you install the tool and configure it to work with your Cloudflare account. Documentation can be found here.

To generate using Wrangler, run this command:

wrangler generate my-project https://github.com/CS-5/cf-workers-base

👩 💻 Developing

src/index.js calls the request handler in src/handler.ts, and will return the request method for the given request.

✏️ Formatting

This template uses prettier to format the project. To invoke, run npm run format.

👀 Previewing and Publishing

For information on how to preview and publish your worker, please see the Wrangler docs.

⚠️ Caveats

The service-worker-mock used by the tests is not a perfect representation of the Cloudflare Workers runtime. It is a general approximation. We recommend that you test end to end with wrangler dev in addition to a staging environment to test things before deploying.