hono README

The project's README from github.com/honojs/hono. As one markdown file: README.md.

Hono

GitHub Workflow Status GitHub npm npm JSR Bundle Size Bundle Size GitHub commit activity GitHub last commit codecov Discord badge Ask DeepWiki

Hono - means flameπŸ”₯ in Japanese - is a small, simple, and ultrafast web framework built on Web Standards. It works on any JavaScript runtime: Cloudflare Workers, Fastly Compute, Deno, Bun, Vercel, AWS Lambda, Lambda@Edge, and Node.js.

Fast, but not only fast.

import { Hono } from 'hono'
const app = new Hono()

app.get('/', (c) => c.text('Hono!'))

export default app

Quick Start

npm create hono@latest

Features

Documentation

The documentation is available on hono.dev.

Migration

The migration guide is available on docs/MIGRATION.md.

Communication

X and Discord channel are available.

Contributing

Contributions Welcome! You can contribute in the following ways.

For more details, see docs/CONTRIBUTING.md.

Contributors

Thanks to all contributors!

Authors

Yusuke Wada https://github.com/yusukebe

RegExpRouter, SmartRouter, LinearRouter, and PatternRouter are created by Taku Amano https://github.com/usualoma

License

Distributed under the MIT License. See LICENSE for more information.

hono (honojs/hono)

Searching Database…

32.6K Β·GitHub
What is this?Hono (Japanese for 'flame' πŸ”₯) is a small, simple, and ultrafast web framework built on Web Standards for the TypeScript and JavaScript ecosystem.
Is it a framework or a library, and where does the code run?It's a framework: you define routes and middleware, and the same code runs on Cloudflare Workers, Fastly Compute, Deno, Bun, Vercel, AWS Lambda, Lambda@Edge, or Node.js.
How do I get a Hono project running?Install the hono package from npm and follow the Quick Start in the docs at hono.dev β€” the README points there for everything.
Do I need to install other packages alongside it?No β€” it ships with zero dependencies and is built purely on the Web Standard API, so there is nothing else to pull in.
Any install pitfalls to watch for?Very few: it is a single dependency-free package, and the only floor in the repo is Node.js 16.9 or newer for Node deployments.
How fast is it, really?Speed is the headline: RegExpRouter, the default router, avoids linear loops, and the hono/tiny preset weighs under 12kB.
What comes out of the box?Middleware β€” built-in, custom, and third-party are all supported, which is what the README means by 'batteries included'.
How is the TypeScript support?First-class: the README highlights super clean APIs and a 'Types' feature as part of its 'delightful DX'.
Why the name Hono?It means 'flame' in Japanese. The framework was created by Yusuke Wada, and its routers β€” RegExpRouter, SmartRouter, LinearRouter, and PatternRouter β€” were created by Taku Amano.
What are similar projects?remix, elysia, nitro, echo, micro, express, koa, hapi
Creator
honojs
Size
9.9 MB
Stars
32.6K
Age
4y
Commits Β· 90 Days