2022-04-21 23:45:52 +00:00
< div align = "center" >
2023-02-16 14:18:34 +00:00
< a href = "https://hono.dev" >
2022-07-18 02:48:34 +00:00
< img src = "https://raw.githubusercontent.com/honojs/hono/main/docs/images/hono-title.png" width = "500" height = "auto" alt = "Hono" / >
2022-04-21 23:45:52 +00:00
< / a >
< / div >
< hr / >
2021-12-14 20:17:56 +00:00
2022-07-16 08:51:34 +00:00
< p align = "center" >
2023-02-16 14:18:34 +00:00
< a href = "https://hono.dev" > < b > Documentation :point_right: hono.dev< / b > < / a > < br / >
2023-02-17 23:27:54 +00:00
< i > v3 has been released!< / i > < a href = "docs/MIGRATION.md" > Migration guide< / b >
2022-07-16 08:51:34 +00:00
< / p >
< hr / >
2022-12-20 21:42:27 +00:00
[](https://github.com/honojs/hono/actions)
2022-07-18 02:48:34 +00:00
[](https://github.com/honojs/hono/blob/main/LICENSE)
2022-02-21 15:01:31 +00:00
[](https://www.npmjs.com/package/hono)
2022-02-23 02:20:29 +00:00
[](https://www.npmjs.com/package/hono)
2023-02-14 13:50:58 +00:00
[](https://bundlephobia.com/result?p=hono)
[](https://bundlephobia.com/result?p=hono)
2022-02-21 15:01:31 +00:00
[](https://www.npmjs.com/package/hono)
2022-04-26 08:15:16 +00:00
[](https://github.com/honojs/hono/pulse)
2022-07-18 02:48:34 +00:00
[](https://github.com/honojs/hono/commits/main)
2022-07-02 12:48:32 +00:00
[](https://doc.deno.land/https/deno.land/x/hono/mod.ts)
2022-09-15 00:53:03 +00:00
[](https://discord.gg/KMh2eNSdxV)
2022-02-21 15:01:31 +00:00
2023-04-08 09:34:03 +00:00
Hono - _**\[炎\] means flame🔥 in Japanese**_ - is a small, simple, and ultrafast web framework for the Edges.
2023-05-13 23:33:34 +00:00
It works on any JavaScrip runtime: Cloudflare Workers, Fastly Compute@Edge, Deno, Bun, Vercel, Lagon, AWS Lambda, and Node.js.
2023-02-17 23:27:54 +00:00
Fast, but not only fast.
2021-12-17 06:53:31 +00:00
2022-05-13 03:30:06 +00:00
```ts
2022-01-09 12:10:12 +00:00
import { Hono } from 'hono'
2022-01-01 06:29:41 +00:00
const app = new Hono()
2021-12-17 06:53:31 +00:00
2023-02-17 23:27:54 +00:00
app.get('/', (c) => c.text('Hono!'))
2021-12-17 06:53:31 +00:00
2022-07-16 08:51:34 +00:00
export default app
2021-12-17 06:53:31 +00:00
```
2023-02-22 20:47:56 +00:00
## Quick Start
```
npm create hono@latest my-app
```
2022-01-08 00:48:22 +00:00
## Features
2021-12-17 06:53:31 +00:00
2023-05-19 03:07:18 +00:00
- **Ultrafast** 🚀 - The router `RegExpRouter` is really fast. Not using linear loops. Fast.
- **Lightweight** 🪶 - The `hono/tiny` preset is under 12kB. Hono has zero dependencies and uses only the Web Standard API.
- **Multi-runtime** 🌍 - Works on Cloudflare Workers, Fastly Compute@Edge, Deno, Bun, Lagon, AWS Lambda, or Node.js. The same code runs on all platforms.
- **Batteries Included** 🔋 - Hono has built-in middleware, custom middleware, and third-party middleware. Batteries included.
- **Delightful DX** 🛠️ - Super clean APIs. First-class TypeScript support. Now, we've got "Types".
2021-12-14 20:17:56 +00:00
2022-07-02 09:29:09 +00:00
## Benchmarks
2023-02-17 23:27:54 +00:00
**Hono is the fastest**, compared to other routers for Cloudflare Workers.
2022-01-05 09:41:29 +00:00
2023-02-17 23:27:54 +00:00
```
2023-05-13 23:33:34 +00:00
Hono x 402,820 ops/sec ±4.78% (80 runs sampled)
itty-router x 212,598 ops/sec ±3.11% (87 runs sampled)
sunder x 297,036 ops/sec ±4.76% (77 runs sampled)
worktop x 197,345 ops/sec ±2.40% (88 runs sampled)
2022-09-20 14:06:05 +00:00
Fastest is Hono
2023-05-13 23:33:34 +00:00
✨ Done in 28.06s.
2021-12-27 16:34:09 +00:00
```
2022-07-16 08:51:34 +00:00
## Documentation
2022-07-08 00:22:10 +00:00
2023-02-16 14:18:34 +00:00
The documentation is available on [hono.dev ](https://hono.dev ).
2021-12-14 20:31:37 +00:00
2022-07-16 08:51:34 +00:00
## Migration
2022-01-05 20:11:37 +00:00
2023-02-17 23:27:54 +00:00
The migration guide is available on [docs/MIGRATION.md ](docs/MIGRATION.md ).
2021-12-14 20:31:37 +00:00
2022-08-26 12:44:23 +00:00
## Communication
2022-09-15 00:53:03 +00:00
[Twitter ](https://twitter.com/honojs ) and [Discord channel ](https://discord.gg/KMh2eNSdxV ) are available.
2022-08-26 12:44:23 +00:00
2022-01-05 20:11:37 +00:00
## Contributing
2022-04-25 22:58:08 +00:00
Contributions Welcome! You can contribute in the following ways.
2022-01-05 20:11:37 +00:00
2022-07-23 00:46:20 +00:00
- Create an Issue - Propose a new feature. Report a bug.
- Pull Request - Fix a bug and typo. Refactor the code.
- Create third-party middleware - Instruct below.
- Share - Share your thoughts on the Blog, Twitter, and others.
- Make your application - Please try to use Hono.
For more details, see [docs/CONTRIBUTING.md ](docs/CONTRIBUTING.md ).
2022-01-05 20:11:37 +00:00
2022-02-15 08:19:53 +00:00
## Contributors
2023-05-13 23:33:34 +00:00
Thanks to [all contributors ](https://github.com/honojs/hono/graphs/contributors )!
2022-02-15 08:19:53 +00:00
2023-04-08 09:34:03 +00:00
## Authors
2021-12-14 19:26:22 +00:00
Yusuke Wada < https: / / github . com / yusukebe >
2023-05-13 23:33:34 +00:00
_RegExpRouter_, _SmartRouter_ , _LinearRouter_ , and _PatternRouter_ are created by Taku Amano < https: // github . com / usualoma >
2023-03-06 11:42:05 +00:00
2021-12-14 19:26:22 +00:00
## License
2022-01-07 08:34:12 +00:00
Distributed under the MIT License. See [LICENSE ](LICENSE ) for more information.
