# NestJS开发模板

**Repository Path**: li-muchen/nest-js-development-template

## Basic Information

- **Project Name**: NestJS开发模板
- **Description**: nestjs 开发模板
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-08-08
- **Last Updated**: 2026-01-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# NestJS开发模板项目

## 项目概述

这是一个基于NestJS的开发模板项目，采用了标准的分层架构，用于快速构建RESTful API服务。

## 技术栈

- **NestJS**: 后端框架
- **TypeORM**: ORM框架，连接MySQL数据库
- **TypeScript**: 开发语言
- **class-validator**: 数据验证
- **Jest**: 测试框架

## 目录结构

```
├── src/                      # 源代码目录
│   ├── controllers/          # 控制器层
│   │   └── user.controller.ts # 用户控制器
│   ├── dto/                  # 数据传输对象
│   │   └── user.dto.ts      # 用户DTO
│   ├── entities/             # 实体层
│   │   └── user.entity.ts   # 用户实体
│   ├── modules/              # 模块层
│   │   └── user.module.ts   # 用户模块
│   ├── services/             # 服务层
│   │   └── user.service.ts  # 用户服务
│   ├── tests/                # 单元测试
│   │   └── user.controller.spec.ts # 用户控制器测试
│   ├── utils/                # 工具类
│   │   ├── all-exceptions.filter.ts # 全局异常过滤器
│   │   └── transform.interceptor.ts # 响应转换拦截器
│   ├── app.module.ts         # 应用主模块
│   └── main.ts               # 应用入口
├── test/                     # 端到端测试
│   ├── app.e2e-spec.ts       # 端到端测试文件
│   └── jest-e2e.json         # Jest端到端测试配置
├── .eslintrc.js              # ESLint配置
├── .prettierrc               # Prettier配置
├── nest-cli.json             # NestJS CLI配置
├── package.json              # 项目依赖配置
├── tsconfig.json             # TypeScript配置
└── tsconfig.build.json       # TypeScript构建配置
```

## 主要文件说明

### 控制器层
- **user.controller.ts**: 处理用户相关的HTTP请求，定义API接口

### 服务层
- **user.service.ts**: 实现用户相关的业务逻辑

### 实体层
- **user.entity.ts**: 定义用户数据模型，映射数据库表结构

### 数据传输对象
- **user.dto.ts**: 定义用户数据的验证规则和传输格式

### 模块层
- **user.module.ts**: 整合用户相关的控制器、服务和实体

### 工具类
- **all-exceptions.filter.ts**: 统一处理应用程序中的所有异常
- **transform.interceptor.ts**: 统一格式化API响应格式

### 应用配置
- **main.ts**: 应用程序入口，配置全局管道、拦截器等
- **app.module.ts**: 应用程序主模块，整合所有功能模块

## Installation

```bash
$ yarn install
```

## Running the app

```bash
# development
$ yarn run start

# watch mode
$ yarn run start:dev

# production mode
$ yarn run start:prod
```

## Test

```bash
# unit tests
$ yarn run test

# e2e tests
$ yarn run test:e2e

# test coverage
$ yarn run test:cov
```