1 Star 0 Fork 26

xiaoshi_love / Nest-Web

forked from 蕉zisuzz / Nest-Web 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
README.md 1.69 KB
一键复制 编辑 原始数据 按行查看 历史
蕉zisuzz 提交于 2019-10-08 10:57 . 新增性能监控切面

Nest Web

基于Nest的快速开发框架,Nest真香嗷!

快速启动

Docker容器外部署

  • 创建 .env 文件,然后执行cp .env.example .env 命令。替换.env文件中的环境配置(比如mysql/mariadb的链接参数)
  • 安装依赖 yarn
  • 启动服务:yarn start (3000端口)
  • 或者
  • 安装依赖 npm i
  • 启动服务:npm start (3000端口)

Docker容器内部署

只需运行已经准备好的bash脚本::

$ ./init

它会构建Docker镜像,在dev下运行Nest的应用,监听的是80端口

Test

# 单元测试
$ docker exec -it nest yarn test

# e2e 测试
$ docker exec -it nest yarn test:e2e

# 测试覆盖率
$ docker exec -it nest yarn test:cov

配置环境

在configservice中读取 .env中的配置变量。 包括Mysql链接配置等

Swagger

运行在:http://localhost:3000/api/docs

TypeORM 集成

TypeORM TypeORM作为持久层,支持多数据库、多链接等。更多详情可以参考官方文档。

JWT鉴权

已经实现了安全的登陆和注册方式 密码散列也已经实现

统一的数据返回

support/code中 实现了ApiResult 固定返回格式:

{
  "timestamp": "2019-10-08T01:52:37.965Z",
  "Data": {},
  "status": 200,
  "message": "请求成功"
}

性能耗时监听切面

在控制台中可以看到请求处理时长

  /api/auth/register,处理耗时:163ms

统一的业务异常返回-TODO

通过各种横切面进行异常拦截 固定返回格式:

{
  "timestamp": "2019-10-08T01:52:37.965Z",
  "Data": {},
  "status": -10001,
  "message": "系统错误"
}

热部署-TODO

TypeScript
1
https://gitee.com/xiaoshi_love/Nest-Web.git
git@gitee.com:xiaoshi_love/Nest-Web.git
xiaoshi_love
Nest-Web
Nest-Web
master

搜索帮助

53164aa7 5694891 3bd8fe86 5694891