Cloudflare Pages

Cloudflare Pages is an edge platform for full-stack web applications. It serves static files and dynamic content provided by Cloudflare Workers.

Hono fully supports Cloudflare Pages. It introduces a delightful developer experience. Vite's dev server is fast, and deploying with Wrangler is super quick.

1. Setup

A starter for Cloudflare Pages is available. Start your project with "create-hono" command. Select cloudflare-pages template for this example.

npm create hono@latest my-app

yarn create hono my-app

pnpm create hono my-app

bunx create-hono my-app

deno run -A npm:create-hono my-app

Move into my-app and install the dependencies.

npmyarnpnpmbun

cd my-app
npm i

cd my-app
yarn

cd my-app
pnpm i

cd my-app
bun i

Below is a basic directory structure.

text

./
├── package.json
├── public
│   └── static // Put your static files.
│       └── style.css // You can refer to it as `/static/style.css`.
├── src
│   ├── index.tsx // The entry point for server-side.
│   └── renderer.tsx
├── tsconfig.json
└── vite.config.ts

2. Hello World

Edit src/index.tsx like the following:

tsx

import { Hono } from 'hono'
import { renderer } from './renderer'

const app = new Hono()

app.get('*', renderer)

app.get('/', (c) => {
  return c.render(<h1>Hello, Cloudflare Pages!</h1>)
})

export default app

3. Run

Run the development server locally. Then, access http://localhost:5173 in your Web browser.

npmyarnpnpmbun

npm run dev

yarn dev

pnpm dev

bun run dev

4. Deploy

If you have a Cloudflare account, you can deploy to Cloudflare. In package.json, $npm_execpath needs to be changed to your package manager of choice.

npmyarnpnpmbun

npm run deploy

yarn deploy

pnpm run deploy

bun run deploy

Bindings

You can use Cloudflare Bindings like Variables, KV, D1, and others. In this section, let's use Variables and KV.

Create `wrangler.toml`

First, create wrangler.toml for local Bindings:

touch wrangler.toml

Edit wrangler.toml. Specify Variable with the name MY_NAME.

toml

[vars]
MY_NAME = "Hono"

Create KV

Next, make the KV. Run the following wrangler command:

wrangler kv:namespace create MY_KV --preview

Note down the preview_id as the following output:

{ binding = "MY_KV", preview_id = "abcdef" }

Specify preview_id with the name of Bindings, MY_KV:

toml

[[kv_namespaces]]
binding = "MY_KV"
id = "abcdef"

Edit `vite.config.ts`

Edit the vite.config.ts:

import devServer from '@hono/vite-dev-server'
import adapter from '@hono/vite-dev-server/cloudflare'
import build from '@hono/vite-cloudflare-pages'
import { defineConfig } from 'vite'

export default defineConfig({
  plugins: [
    devServer({
      entry: 'src/index.tsx',
      adapter, // Cloudflare Adapter
    }),
    build(),
  ],
})

Use Bindings in your application

Use Variable and KV in your application. Set the types.

type Bindings = {
  MY_NAME: string
  MY_KV: KVNamespace
}

const app = new Hono<{
  Bindings: Bindings
}>()

Use them:

tsx

app.get('/', async (c) => {
  await c.env.MY_KV.put('name', c.env.MY_NAME)
  const name = await c.env.MY_KV.get('name')
  return c.render(<h1>Hello! {name}</h1>)
})

In production

For Cloudflare Pages, you will use wrangler.toml for local development, but for production, you will set up Bindings in the dashboard.

Client-side

You can write client-side scripts and import them into your application using Vite's features. If /src/client.ts is the entry point for the client, simply write it in the script tag. Additionally, import.meta.env.PROD is useful for detecting whether it's running on a dev server or in the build phase.

tsx

app.get('/', (c) => {
  return c.html(
    <html>
      <head>
        {import.meta.env.PROD ? (
          <script type='module' src='/static/client.js'></script>
        ) : (
          <script type='module' src='/src/client.ts'></script>
        )}
      </head>
      <body>
        <h1>Hello</h1>
      </body>
    </html>
  )
})

In order to build the script properly, you can use the example config file vite.config.ts as shown below.

import pages from '@hono/vite-cloudflare-pages'
import devServer from '@hono/vite-dev-server'
import { defineConfig } from 'vite'

export default defineConfig(({ mode }) => {
  if (mode === 'client') {
    return {
      build: {
        rollupOptions: {
          input: './src/client.ts',
          output: {
            entryFileNames: 'static/client.js',
          },
        },
      },
    }
  } else {
    return {
      plugins: [
        pages(),
        devServer({
          entry: 'src/index.tsx',
        }),
      ],
    }
  }
})

You can run the following command to build the server and client script.

vite build --mode client && vite build

Cloudflare Pages ​

1. Setup ​

2. Hello World ​

3. Run ​

4. Deploy ​

Bindings ​

Create wrangler.toml ​

Create KV ​

Edit vite.config.ts ​

Use Bindings in your application ​

In production ​

Client-side ​

Cloudflare Pages

1. Setup

2. Hello World

3. Run

4. Deploy

Bindings

Create `wrangler.toml`

Create KV

Edit `vite.config.ts`

Use Bindings in your application

In production

Client-side