@lzui/nest-crud

Appearance

安装指南 ​

📋 前置条件 ​

在安装 @lzui/nest-crud 之前，请确保您的项目满足以下条件：

  • Node.js >= 20.0.0
  • NestJS >= 11.0.0 - 核心框架
  • TypeORM >= 0.3.0 - 数据库 ORM 工具

🚀 安装 ​

使用 pnpm ​

bash
pnpm add @lzui/nest-crud

使用 npm ​

bash
npm install @lzui/nest-crud

使用 yarn ​

bash
yarn add @lzui/nest-crud

📦 依赖说明 ​

@lzui/nest-crud 依赖于以下核心包（会自动安装）：

  • @nestjs/common - NestJS 公共模块
  • @nestjs/core - NestJS 核心模块
  • @nestjs/mapped-types - 类型映射工具
  • @nestjs/typeorm - TypeORM 集成模块
  • reflect-metadata - 元数据反射 API
  • typeorm - 数据库 ORM

必需依赖 ​

@lzui/nest-crud 目前只支持 PostgreSQL 数据库，请安装相应的驱动：

bash
# PostgreSQL（当前唯一支持的数据库）
pnpm add pg

✅ 快速验证 ​

安装完成后，您可以在项目中导入并使用 @lzui/nest-crud：

typescript
import { CrudController, BaseController, BaseService } from '@lzui/nest-crud';

// 验证导入是否成功
console.log('@lzui/nest-crud 安装成功');

📖 下一步 ​