Next.js

Next.js is a flexible React framework that gives you building blocks to create fast web applications.

You can run Hono on Next.js when using the Node.js runtime.
On Vercel, deploying Hono with Next.js is easy by using Vercel Functions.

1. Setup

A starter for Next.js is available. Start your project with "create-hono" command. Select nextjs template for this example.

npm create hono@latest my-app

yarn create hono my-app

pnpm create hono my-app

bun create hono@latest my-app

deno init --npm hono my-app

Move into my-app and install the dependencies.

cd my-app
npm i

cd my-app
yarn

cd my-app
pnpm i

cd my-app
bun i

2. Hello World

If you use the App Router, Edit app/api/[[...route]]/route.ts. Refer to the Supported HTTP Methods section for more options.

import { Hono } from 'hono'
import { handle } from '@hono/vercel'

const app = new Hono().basePath('/api')

app.get('/hello', (c) => {
  return c.json({
    message: 'Hello Next.js!',
  })
})

export const GET = handle(app)

export const POST = handle(app)

handle comes from the @hono/vercel package, which the starter installs. On an existing project, add it with npm i @hono/vercel.

3. Run

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

npm run dev

yarn dev

pnpm dev

bun run dev

Now, /api/hello just returns JSON, but if you build React UIs, you can create a full-stack application with Hono.

4. Deploy

If you have a Vercel account, you can deploy by linking the Git repository.

Pages Router

If you use the Pages Router, you'll need to install the Node.js adapter first.

npm i @hono/node-server

yarn add @hono/node-server

pnpm add @hono/node-server

bun add @hono/node-server

Then, you can utilize the getRequestListener function imported from @hono/node-server in pages/api/[[...route]].ts.

import { getRequestListener } from '@hono/node-server'
import { Hono } from 'hono'
import type { PageConfig } from 'next'

export const config: PageConfig = {
  api: {
    bodyParser: false,
  },
}

const app = new Hono().basePath('/api')

app.get('/hello', (c) => {
  return c.json({
    message: 'Hello Next.js!',
  })
})

export default getRequestListener(app.fetch)

In order for this to work with the Pages Router, it's important to disable Vercel Node.js helpers by setting up an environment variable in your project dashboard or in your .env file.

NODEJS_HELPERS=0