NestJS 运行指南

NestJS

v10.x

TypeScript

官方网站 GitHub

NestJS 是一个渐进式 Node.js 框架，用于构建高效、可靠、可扩展的服务器端应用程序。 使用 TypeScript 编写，具有良好的架构设计和丰富的生态系统。

项目结构

backend

src

main.ts // 应用入口

app.module.ts // 根模块

app.controller.ts // 根控制器

app.service.ts // 根服务

modules // 功能模块目录

auth // 认证模块

auth.controller.ts

auth.module.ts

auth.service.ts

user // 用户模块

user.controller.ts

user.module.ts

user.service.ts

prisma // 数据库模型（如使用 Prisma）

schema.prisma

.env.example // 环境变量示例

package.json

tsconfig.json

第 2 步：安装依赖

运行以下命令安装项目所需的依赖包：

bashbackend

        $
        pnpm install
      

注意

首次安装可能需要几分钟，请耐心等待。如果安装失败，请检查网络连接。

安装完成后，你会看到类似这样的输出：

Packages: +xxx
Done in xxx.xxxs

第 4 步：初始化数据库（如有）

如果项目使用了 Prisma 作为 ORM，需要初始化数据库：

bashbackend

        $
        pnpm prisma generate
      

bashbackend

        $
        pnpm prisma db push
      

如果项目没有 `prisma` 文件夹，可以跳过此步骤。

第 6 步：验证运行

访问 API 文档

如果项目配置了 Swagger，可以访问：

• API 文档: http://localhost:3000/api

测试 API

打开浏览器或使用工具（如 Postman、Apifox）访问：

GET http://localhost:3000

应该会返回类似 Hello World! 或项目的欢迎信息。

常用命令速查

特性	说明
pnpm run dev	启动开发服务器（热更新）
pnpm run start	启动生产服务器
pnpm run build	构建生产版本
pnpm run test	运行测试
pnpm prisma studio	打开数据库可视化界面

下一步

后端已启动！

现在你可以继续启动前端项目，与后端进行联调。

运行 Vue 3 前端 → 同时运行前后端