mirror of
https://github.com/honojs/hono.git
synced 2024-11-25 05:07:03 +01:00
106 lines
4.2 KiB
Markdown
106 lines
4.2 KiB
Markdown
<div align="center">
|
|
<a href="https://hono.dev">
|
|
<img src="https://raw.githubusercontent.com/honojs/hono/main/docs/images/hono-title.png" width="500" height="auto" alt="Hono"/>
|
|
</a>
|
|
</div>
|
|
|
|
<hr />
|
|
|
|
<p align="center">
|
|
<a href="https://hono.dev"><b>Documentation :point_right: hono.dev</b></a><br />
|
|
<i>v3 has been released!</i> <a href="docs/MIGRATION.md">Migration guide</b>
|
|
</p>
|
|
|
|
<hr />
|
|
|
|
[](https://github.com/honojs/hono/actions)
|
|
[](https://github.com/honojs/hono/blob/main/LICENSE)
|
|
[](https://www.npmjs.com/package/hono)
|
|
[](https://www.npmjs.com/package/hono)
|
|
[](https://bundlephobia.com/result?p=hono)
|
|
[](https://bundlephobia.com/result?p=hono)
|
|
[](https://www.npmjs.com/package/hono)
|
|
[](https://github.com/honojs/hono/pulse)
|
|
[](https://github.com/honojs/hono/commits/main)
|
|
[](https://doc.deno.land/https/deno.land/x/hono/mod.ts)
|
|
[](https://discord.gg/KMh2eNSdxV)
|
|
|
|
Hono - _**\[炎\] means flame🔥 in Japanese**_ - is a small, simple, and ultrafast web framework for the Edges.
|
|
It works on any JavaScript runtime: Cloudflare Workers, Fastly Compute@Edge, Deno, Bun, Vercel, Lagon, AWS Lambda, Lambda@Edge, and Node.js.
|
|
|
|
Fast, but not only fast.
|
|
|
|
```ts
|
|
import { Hono } from 'hono'
|
|
const app = new Hono()
|
|
|
|
app.get('/', (c) => c.text('Hono!'))
|
|
|
|
export default app
|
|
```
|
|
|
|
## Quick Start
|
|
|
|
```
|
|
npm create hono@latest my-app
|
|
```
|
|
|
|
## Features
|
|
|
|
- **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, Lambda@Edge, 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".
|
|
|
|
## Benchmarks
|
|
|
|
**Hono is the fastest**, compared to other routers for Cloudflare Workers.
|
|
|
|
```
|
|
Hono x 510,171 ops/sec ±4.61% (82 runs sampled)
|
|
itty-router x 285,810 ops/sec ±4.13% (85 runs sampled)
|
|
sunder x 345,272 ops/sec ±4.46% (87 runs sampled)
|
|
worktop x 203,468 ops/sec ±3.03% (91 runs sampled)
|
|
Fastest is Hono
|
|
✨ Done in 28.68s.
|
|
```
|
|
|
|
## Documentation
|
|
|
|
The documentation is available on [hono.dev](https://hono.dev).
|
|
|
|
## Migration
|
|
|
|
The migration guide is available on [docs/MIGRATION.md](docs/MIGRATION.md).
|
|
|
|
## Communication
|
|
|
|
[Twitter](https://twitter.com/honojs) and [Discord channel](https://discord.gg/KMh2eNSdxV) are available.
|
|
|
|
## Contributing
|
|
|
|
Contributions Welcome! You can contribute in the following ways.
|
|
|
|
- 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).
|
|
|
|
## Contributors
|
|
|
|
Thanks to [all contributors](https://github.com/honojs/hono/graphs/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](LICENSE) for more information.
|