Skip to content

Center-for-AI-Innovation/cloudflare-workers

Repository files navigation

Cloudflare Workers for Serverless Functions

Included

Setup

Install dependencies

pnpm install

Run

pnpm dev

Lint

pnpm lint

Test

pnpm test

Deploy to Cloudflare

pnpm run deploy

Code Tour

Base hono app exported from app.ts. Local development uses @hono/node-server defined in index.ts - update this file or create a new entry point to use your preferred runtime.

Typesafe env defined in env.ts - add any other required environment variables here. The application will not start if any required environment variables are missing

See src/routes/tasks for an example Open API group. Copy this folder / use as an example for your route groups.

All app routes are grouped together and exported into single type as AppType in app.ts for use in RPC / hono/client.

Endpoints

Path Description
GET /doc Open API Specification
GET /reference Scalar API Documentation
GET /tasks List all tasks
POST /tasks Create a task
GET /tasks/{id} Get one task by id
PATCH /tasks/{id} Patch one task by id
DELETE /tasks/{id} Delete one task by id

References