https://github.com/thesephi/create-oak-cloudflare-worker
npm init template for a Cloudflare Workers application
https://github.com/thesephi/create-oak-cloudflare-worker
api cloudflare-workers decorator oak oak-routing-ctrl scaffold typescript
Last synced: 4 months ago
JSON representation
npm init template for a Cloudflare Workers application
- Host: GitHub
- URL: https://github.com/thesephi/create-oak-cloudflare-worker
- Owner: Thesephi
- License: mit
- Created: 2024-06-17T22:53:37.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-20T01:58:11.000Z (over 1 year ago)
- Last Synced: 2025-12-22T08:49:49.863Z (6 months ago)
- Topics: api, cloudflare-workers, decorator, oak, oak-routing-ctrl, scaffold, typescript
- Language: JavaScript
- Homepage:
- Size: 91.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# create-oak-cloudflare-worker
Starter template to develop a Cloudflare Workers application with `@oak/oak` and `@dklab/oak-routing-ctrl`.
Read more:
- [Oakserver](https://oakserver.org/)
- [oak-routing-ctrl](https://jsr.io/@dklab/oak-routing-ctrl)
- [Cloudflare Workers](https://workers.cloudflare.com/)
# How to use this template
```bash
npm create oak-cloudflare-worker@latest
```
# Example Deployment
A deployment is available for demo at the following URL: https://oak-routing-ctrl-cloudflare.dklab.workers.dev/swagger
```bash
curl \
-H"x-foo: lorem" \
-H"x-bar: ipsum" \
-H"Content-Type: application/json" \
https://oak-routing-ctrl-cloudflare.dklab.workers.dev/echo/world\?name=dolor -d'{"raz":"maz"}'
```
```
# output
{"query":{"name":"dolor"},"body":{"raz":"maz"},"param":{"name":"world"}}
```
Please keep in mind that there's no uptime guarantee for the deployment above, so it might be unavailable from time to time due to exceeding traffic allowances.