Hono Starter Templates

To set up and run the Cloudflare Pages starter template locally, use the following commands:

1. Install dependencies: npm install
2. Start the development server: npm run dev

To perform a local build of the project to verify the production build process, run:

npm install
vc build

To get started with the Node.js template, install the dependencies and start the development server using your preferred package manager. Once running, the application is accessible at http://localhost:3000.

npm install
npm run dev

To run the Fastly template on your local machine for development, use the following commands:

1. Install dependencies: npm install
2. Start the development server: npm run start
3. Access the application at http://localhost:7676

npm install
npm run start

# Open http://localhost:7676

To deploy your Hono application to the Vercel platform, use the Vercel CLI (vc) to trigger a deployment after installing dependencies:

npm install
vc deploy

To deploy your application to Cloudflare Pages, run the deploy script:

npm run deploy

To get type safety for your Fastly resources (like KV Stores or Config Stores), use buildFire from @fastly/hono-fastly-compute instead of the standard fire.

1. Call buildFire with an object mapping your desired resource names to their Fastly types (e.g., 'KVStore' or 'ConfigStore:name').
2. Pass fire.Bindings as the generic parameter to the Hono constructor to enable typed access to these resources within your routes.

import { buildFire } from '@fastly/hono-fastly-compute'

// Define your resources
const fire = buildFire({
  assets: 'KVStore', // A KV Store named 'assets'
  mySettings: 'ConfigStore:my-settings' // A Config Store named 'my-settings'
})

// Pass fire.Bindings as the generic parameter
const app = new Hono<{ Bindings: fire.Bindings }>()

To start a local development server for this Hono template, ensure you have the Vercel CLI installed globally. Run the following commands to install dependencies and start the development environment:

1. Install dependencies: npm install
2. Start development server: vc dev
3. Access the application at http://localhost:3000

To set up and deploy a Hono application using the Lambda@Edge template, use npm to install dependencies and run the deployment command. This template is designed to run your Hono application at the edge using AWS Lambda@Edge.

npm install
npm run deploy

To generate or synchronize TypeScript types based on your specific Cloudflare Worker configuration (such as environment variables and bindings), run the cf-typegen script. This ensures your local development environment is aware of the bindings available in your production environment.

npm run cf-typegen

To start the development server for the Cloudflare Workers template, use the following commands:

1. Install dependencies: npm install
2. Start the development environment: npm run dev

To start the local development environment for the Cloudflare Workers + Vite template, use the dev script. This typically starts the Vite development server to provide hot module replacement (HMR) and local testing.

npm run dev