You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
131 lines
5.4 KiB
131 lines
5.4 KiB
<p align="center">
|
|
<a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="200" alt="Nest Logo" /></a>
|
|
</p>
|
|
|
|
[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
|
|
[circleci-url]: https://circleci.com/gh/nestjs/nest
|
|
|
|
<p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
|
|
<p align="center">
|
|
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
|
|
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
|
|
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
|
|
<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
|
|
<a href="https://coveralls.io/github/nestjs/nest?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9" alt="Coverage" /></a>
|
|
<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
|
|
<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
|
|
<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
|
|
<a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg"/></a>
|
|
<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
|
|
<a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow"></a>
|
|
</p>
|
|
<!--[](https://opencollective.com/nest#backer)
|
|
[](https://opencollective.com/nest#sponsor)-->
|
|
|
|
## Description
|
|
|
|
[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
$ pnpm install
|
|
```
|
|
|
|
## Running the app
|
|
|
|
```bash
|
|
# development
|
|
$ pnpm run start
|
|
|
|
# watch mode
|
|
$ pnpm run start:dev
|
|
|
|
# production mode
|
|
$ pnpm run start:prod
|
|
```
|
|
|
|
## Test
|
|
|
|
```bash
|
|
# unit tests
|
|
$ pnpm run test
|
|
|
|
# e2e tests
|
|
$ pnpm run test:e2e
|
|
|
|
# test coverage
|
|
$ pnpm run test:cov
|
|
```
|
|
|
|
## Support
|
|
|
|
Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
|
|
|
|
## Stay in touch
|
|
|
|
- Author - [Kamil Myśliwiec](https://kamilmysliwiec.com)
|
|
- Website - [https://nestjs.com](https://nestjs.com/)
|
|
- Twitter - [@nestframework](https://twitter.com/nestframework)
|
|
|
|
## License
|
|
|
|
Nest is [MIT licensed](LICENSE).
|
|
|
|
|
|
## dirTree
|
|
|
|
```
|
|
/src
|
|
│ app.module.ts # 主模块
|
|
│ main.ts # 应用入口文件
|
|
│
|
|
├──/common # 公共服务目录
|
|
│ ├──/filters # 异常过滤器等
|
|
│ │ ├──/http-exception.filter.ts
|
|
│ │ ├──/validation-filter.ts
|
|
│ │ └──/... # 更多过滤器
|
|
│ ├──/guards # 守卫
|
|
│ │ ├──/auth.guard.ts
|
|
│ │ ├──/roles.guard.ts
|
|
│ │ └──/... # 更多守卫
|
|
│ ├──/interceptors # 拦截器
|
|
│ │ ├──/logging.interceptor.ts
|
|
│ │ ├──/timeout.interceptor.ts
|
|
│ │ └──/... # 更多拦截器
|
|
│ ├──/pipes # 管道
|
|
│ │ ├──/validation.pipe.ts
|
|
│ │ ├──/transform.pipe.ts
|
|
│ │ └──/... # 更多管道
|
|
│ └──/decorators # 装饰器
|
|
│ ├──/auth.decorator.ts
|
|
│ ├──/log.decorator.ts
|
|
│ └──/... # 更多装饰器
|
|
│
|
|
├──/config # 配置文件
|
|
│ ├──/database.config.ts
|
|
│ ├──/app.config.ts
|
|
│ └──/... # 更多配置
|
|
│
|
|
├──/modules # 模块目录
|
|
│ ├──/user # 用户模块
|
|
│ │ ├──/user.module.ts
|
|
│ │ ├──/controllers # 模块控制器
|
|
│ │ ├──/services # 模块服务
|
|
│ │ ├──/dtos # 模块 DTOs
|
|
│ │ ├──/entities # 模块实体
|
|
│ │ └──/... # 模块其他文件
|
|
│ └──/... # 更多模块
|
|
│
|
|
├──/providers # 服务提供者
|
|
│ ├──/app.provider.ts
|
|
│ └──/... # 更多提供者
|
|
│
|
|
├──/entities # 数据实体定义
|
|
│ ├──/user.entity.ts
|
|
│ └──/... # 更多实体
|
|
│
|
|
└──/utils # 工具类和实用函数
|
|
├──/logger.ts
|
|
└──/... # 更多工具
|
|
```
|
|
|