# lzo-admin-nestjs

**Repository Path**: lzo-gitee/lzo-admin-nestjs

## Basic Information

- **Project Name**: lzo-admin-nestjs
- **Description**: nestjs xiangm ceshi
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-04-04
- **Last Updated**: 2025-04-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 创建项目
```shell
$ npm init @nestjs/cli
$ nest new project-name
$ nest g module user
$ nest g controller user --no-spec

 # 一次性创建(生成新的CRUD一整套资源)
 $ nest g res user --no-spec
```


## 目录结构
```shell

复制
src/
├── app.module.ts          # 根模块
├── main.ts                # 应用入口文件
├── common/                # 公共模块和工具
│   ├── decorators/        # 自定义装饰器
│   ├── filters/           # 异常过滤器
│   ├── guards/            # 守卫
│   ├── interceptors/      # 拦截器
│   ├── middleware/        # 中间件
│   ├── pipes/             # 管道
│   └── utils/             # 工具函数
├── config/                # 配置文件
│   ├── app.config.ts      # 应用配置
│   └── database.config.ts # 数据库配置
├── modules/               # 功能模块
│   ├── auth/              # 认证模块
│   ├── users/             # 用户模块
│   └── ...                # 其他模块
└── shared/                # 共享资源
    ├── entities/          # 数据库实体
    ├── dtos/              # 数据传输对象
    └── interfaces/        # 接口定义
```

### 功能模块结构 (以 users 模块为例)

```shell
modules/
└── users/
    ├── users.controller.ts    # 控制器
    ├── users.service.ts       # 服务层
    ├── users.module.ts        # 模块定义
    ├── users.repository.ts    # 数据访问层(可选)
    ├── users.dto.ts           # 模块专用DTO
    ├── users.interface.ts     # 模块专用接口
    ├── users.entity.ts        # 模块专用实体(如果不用shared/entities)
    ├── constants/             # 模块常量
    └── schemas/               # 数据库模式(MongoDB等使用)

```

### 共享目录结构

```shell
shared/
├── entities/                  # 数据库实体(TypeORM/Sequelize等)
│   ├── user.entity.ts
│   └── product.entity.ts
├── dtos/                      # 数据传输对象
│   ├── create-user.dto.ts
│   └── update-user.dto.ts
├── interfaces/                # 类型接口
│   ├── user.interface.ts
│   └── response.interface.ts
└── constants/                 # 全局常量
    ├── enum.ts
    └── app.constants.ts
```

### 公共工具目录
```shell
common/
├── decorators/                # 自定义装饰器
│   ├── roles.decorator.ts
│   └── public.decorator.ts
├── filters/                   # 异常过滤器
│   ├── http-exception.filter.ts
│   └── all-exceptions.filter.ts
├── guards/                    # 守卫
│   ├── roles.guard.ts
│   └── jwt-auth.guard.ts
├── interceptors/              # 拦截器
│   ├── logging.interceptor.ts
│   └── transform.interceptor.ts
├── middleware/                # 中间件
│   └── logger.middleware.ts
├── pipes/                     # 管道
│   ├── validation.pipe.ts
│   └── parse-int.pipe.ts
└── utils/                     # 工具函数
    ├── helpers.ts
    └── logger.ts

```

### 测试
```shell
test/
├── e2e/                       # 端到端测试
│   ├── app.e2e-spec.ts
│   └── auth.e2e-spec.ts
└── unit/                      # 单元测试
    ├── users/
    │   ├── users.service.spec.ts
    │   └── users.controller.spec.ts
    └── shared/
        └── utils.spec.ts

```