阅读 198

NestJS入门系列(一)--搭建项目

Nest背景

Nest 是一个用于构建高效,可扩展的 Node.js 服务器端应用程序的框架。它使用渐进式JavaScript,内置并完全支持 TypeScript(但仍然允许开发人员使用纯 JavaScript 编写代码)并结合了 OOP(面向对象编程),FP(函数式编程)和 FRP(函数式响应编程)的元素。

在底层,Nest使用强大的 HTTP Server 框架,如 Express(默认)和 Fastify。Nest 在这些框架之上提供了一定程度的抽象,同时也将其 API 直接暴露给开发人员。这样可以轻松使用每个平台的无数第三方模块。

构建项目

先决条件

请确保您的操作系统上安装了 Node.js(>= 10.13.0)。

安装Nest CLI

$ npm i -g @nestjs/cli 
or
$ yarn global add @nestjs/cli
复制代码

创建项目

目前官方提供三种方案创建新项目,这里我们采用Nest CLI创建新项目

  • 使用CLI安装
$ nest new project-name
复制代码
  • 使用Git安装
$ git clone https://github.com/nestjs/typescript-starter.git project-name
$ cd project-name
$ npm install
$ npm run start
复制代码
  • 手动创建
$ npm i --save @nestjs/core @nestjs/common rxjs reflect-metadata
复制代码

目录结构

├── README.md                         //说明文档
├── dist                              //build文件夹
├── nest-cli.json                       //nest cli配置文件
├── package.json
├── src
│   ├── app.controller.spec.ts
│   ├── app.controller.ts               //带有单个路由的基本控制器
│   ├── app.module.ts                   //应用程序的根模块
│   ├── app.service.ts                  //提供者模块
│   ├── main.ts                         //应用程序入口文件
├── test                                //测试模块
│   ├── app.e2e-spec.ts
│   └── jest-e2e.json
├── tsconfig.build.json
├── tsconfig.json
└── yarn.lock
复制代码

启动项目

$ yarn install 或者 npm install 或者 cnpm install
$ npm run start
复制代码

此命令在 src 目录中的 main.ts 文件中定义的端口上启动 HTTP 服务器。在应用程序运行时, 打开浏览器并访问 http://localhost:3000/ 。 你应该看到 Hello world! 信息。

接下来就可以愉快的开发自己的功能了!