caomeiyouren/hono-template

hono-template 镜像文档

镜像概述

hono-template 是一个基于 Hono 和 TypeScript 的云函数模板，旨在提供灵活且多平台兼容的云函数开发与部署解决方案。该模板支持 Vercel、Cloudflare Workers、Docker 和 Node.js 等多种部署方式，适合快速构建轻量级 API 服务和云函数应用。

核心功能与特性

• 多平台部署支持：兼容 Vercel、Cloudflare Workers、Docker 和 Node.js 运行环境，满足不同场景的部署需求
• TypeScript 原生支持：基于 TypeScript 开发，提供类型安全和更好的开发体验
• 完整开发工具链：包含开发、构建、代码检查（Lint）和提交规范（Commit）等工具命令
• 轻量级框架：基于 Hono 框架，具备高性能和低开销特性，适合云函数场景

使用场景

• 快速开发需要跨平台部署的云函数或 API 服务
• 构建基于 TypeScript 的轻量级后端应用
• 需同时支持 Serverless 平台（如 Vercel、Cloudflare Workers）和容器化部署（Docker）的项目

使用方法

依赖要求

• Node.js 版本 >= 20（本地开发与构建）
• Docker 环境（如需通过 Docker 部署）

Docker 部署示例

基础运行命令

bash
docker run -d -p 3000:3000 --name hono-app caomeiyouren/hono-template

• -p 3000:3000：映射容器端口 3000 到主机端口 3000（默认服务端口，可根据实际配置调整）
• --name hono-app：指定容器名称为 hono-app

自定义环境变量

如需设置环境变量（如 Vercel 部署时的 NODEJS_HELPERS），可通过 -e 参数传递：

bash
docker run -d -p 3000:3000 -e NODEJS_HELPERS=0 --name hono-app caomeiyouren/hono-template

本地开发与构建

拉取代码（如需二次开发）

bash
git clone https://github.com/CaoMeiYouRen/hono-template.git
cd hono-template

安装依赖

bash
npm install

启动开发服务器

bash
npm run dev  # 启动热重载开发环境

构建项目

bash
npm run build  # 编译 TypeScript 代码，生成可部署产物

代码检查与提交

bash
npm run lint   # 运行 ESLint 检查代码规范
npm run commit # 使用规范提交工具提交代码

其他部署方式

Cloudflare Workers 部署

点击下方按钮一键部署：
![Deploy to Cloudflare Workers]([***]

Vercel 部署

点击下方按钮一键部署：
![Deploy with Vercel]([***]

注意：若在 Vercel 部署时遇到请求超时问题，需在 Vercel 控制台设置环境变量 NODEJS_HELPERS=0 并重新部署。

许可证

本项目基于 https://github.com/CaoMeiYouRen/hono-template/blob/master/LICENSE 开源。

项目主页

https://github.com/CaoMeiYouRen/hono-template#readme