# nest-boot

**Repository Path**: qqtt-ah/nest-boot

## Basic Information

- **Project Name**: nest-boot
- **Description**: 一个基于 NestJS 框架的后端 RESTful API 快速开发脚手架，集成了常用的认证、ORM、校验、Swagger 文档等功能，适合快速搭建中小型后端服务。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2025-07-02
- **Last Updated**: 2025-07-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Nest Boot（NestJS 脚手架）

一个基于 NestJS 框架的后端 RESTful API 快速开发脚手架，集成了常用的认证、ORM、校验、Swagger 文档等功能，适合快速搭建中小型后端服务。

## 项目特性

- 基于 [NestJS](https://nestjs.com/) 11.x
- 集成 TypeORM，支持 MySQL
- JWT 认证与 Passport 集成
- 用户注册、登录基础模块
- 参数校验（class-validator）与数据转换（class-transformer）
- Swagger 自动 API 文档
- 环境变量配置（@nestjs/config）
- 代码风格统一（ESLint、Prettier）

## 快速开始

### 1. 克隆项目

```bash
git clone https://gitee.com/qqtt-ah/nest-boot.git
cd nest-boot
```

### 2. 安装依赖

推荐使用 [pnpm](https://pnpm.io/)，也可用 npm/yarn：

```bash
pnpm install
# 或 npm install
# 或 yarn install
```

### 3. 配置环境变量

在 `src/config/env.ts` 或根目录下新建 `.env` 文件，配置数据库等信息。

### 4. 启动开发环境

```bash
pnpm dev
# 或 npm run dev
```

访问 [http://localhost:3000/api-docs](http://localhost:3000/api-docs) 查看 Swagger 文档。

### 5. 构建与生产启动

```bash
pnpm build
pnpm start:prod
```

## 目录结构

```text
src/
  ├── app.controller.ts         // 入口控制器
  ├── app.module.ts             // 根模块
  ├── app.service.ts            // 入口服务
  ├── main.ts                   // 启动文件
  ├── common/                   // 通用工具与响应封装
  ├── config/                   // 配置相关
  ├── modules/                  // 业务模块
  │     ├── auth/               // 认证模块
  │     └── users/              // 用户模块
  └── ...
```

## 主要依赖包说明

- `@nestjs/*`：NestJS 核心及常用模块
- `typeorm`、`mysql2`：数据库 ORM 与驱动
- `@nestjs/jwt`、`passport-jwt`：JWT 认证
- `class-validator`、`class-transformer`：参数校验与转换
- `@nestjs/config`：环境变量管理
- `@nestjs/swagger`、`swagger-ui-express`：API 文档
- `eslint`、`prettier`：代码规范

## 贡献

欢迎提交 Issue 或 PR，完善功能或修复问题。