Lzh on GitHub

入门

使用所需的所有功能创建 Web 服务器,并将其部署到您喜欢的任何位置。

简介

Nitro 是一个开源框架,它使用 unjs/h3 和许多内置功能来构建 Web 服务器。Nitro 会自动使您的代码与任何 部署 提供商和运行时兼容!

Nitro 既可以单独使用,也可以作为 Nuxt 等全栈框架的服务器引擎。

快速开始

您可以使用 在线演练场,而不是设置本地开发环境。
请确保您已安装推荐的设置:

使用入门模板创建新项目:

npx giget@latest nitro nitro-app --install
cd nitro-app

启动开发服务器:

npm run dev

Nitro 已准备就绪,网址是 http://localhost:3000/

如果您想了解发生了什么,请查看 .nitro/dev/index.mjs

构建生产就绪服务器:

npm run build

输出在 .output 目录中,并且可以部署到几乎任何提供商,无需依赖项。

您可以在本地使用以下命令尝试:

npm run preview
您可以在 Nitro 存储库中找到更多示例:nitrojs/nitro/examples

目录结构

入门模板包含一些重要的文件,可帮助您入门。

server/routes/

server/routes/ 目录包含您的应用程序处理程序。您可以在 server/routes/ 目录中创建子目录以创建嵌套处理程序。文件名即为路由路径。

Read more in 指南 > 路由.

server/api/

server/api/ 目录与 server/routes/ 类似,唯一的区别是为了方便起见,其中的路由将带有 /api/ 前缀。

Read more in 指南 > 路由.

server/utils/

此目录包含您的应用程序工具,并支持自动导入。

Read more in 指南 > 工具.

server/plugins/

此目录包含您的自定义 Nitro 插件。

Read more in 指南 > 插件.

nitro.config.ts

nitro.config.ts 文件包含 Nitro 的配置。

Read more in 指南 > 配置.

tsconfig.json

tsconfig.json 文件包含您的项目的 TypeScript 配置。

Read more in 指南 > TypeScript.

package.json

package.json 文件包含您的项目的所有依赖项和脚本。