入门指南
创建具有所有必要功能的网络服务器并在您喜欢的地方进行部署。
简介
Nitro 是一个开源框架,用于使用 unjs/h3 构建网络服务器,并包含许多内置功能。 Nitro 会自动使您的代码与任何 部署 提供商和运行时兼容!
Nitro 可以独立使用,也可以作为完整栈框架(如 Nuxt)的服务器引擎。
快速开始
您可以使用 在线沙盒 而不是设置本地开发环境。
请确保您已安装推荐的设置:
- 最新的 LTS 版本 Node.js 或 Bun。
- Visual Studio Code
使用启动模板创建新项目:
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 仓库中找到更多示例:unjs/nitro/examples
目录结构
启动模板包含一些重要文件,以帮助您入门。
routes/
routes/
目录包含您的应用程序处理程序。您可以在 routes/
目录中创建子目录以创建嵌套处理程序。文件名就是路由路径。
api/
api/
目录类似于 routes/
,唯一的不同之处在于其中的路由将以 /api/
为前缀,便于使用。
utils/
此目录包含您的应用程序工具,并支持自动导入。
plugins/
此目录包含您自定义的 Nitro 插件。
nitro.config.ts
nitro.config.ts
文件包含 Nitro 的配置。
tsconfig.json
tsconfig.json
文件包含您项目的 TypeScript 配置。
package.json
package.json
文件包含您项目的所有依赖项和脚本。