快速开始

本指南帮助您在 5 分钟内 完成后端服务 youlai-nest（Node.js/NestJS）的启动和验证。

前置条件

必需环境：

环境	版本要求	下载地址
Node.js	20+	Node.js官网
pnpm	8+	npm install -g pnpm
MySQL	5.7+ / 8.x	安装教程
Redis	7.x	安装教程

开发工具（可选）：

• Visual Studio Code（推荐）
• WebStorm

项目结构

youlai-nest/
├── src/                      # 核心业务源码
│   ├── main.ts               # 应用入口
│   ├── auth/                 # 认证模块
│   └── system/               # 系统模块
├── sql/                      # 数据库脚本
│   └── mysql/
│       └── youlai_admin.sql  # 初始化脚本
├── .env                      # 环境变量
├── package.json              # 依赖管理
└── tsconfig.json             # TypeScript 配置

安装步骤

数据库初始化

执行数据库脚本：

mysql -u root -p < sql/mysql/youlai_admin.sql

配置修改

修改 .env：

数据库配置：

DB_HOST=localhost
DB_PORT=3306
DB_DATABASE=youlai_admin
DB_USERNAME=root
DB_PASSWORD=your_password

Redis配置：

REDIS_HOST=localhost
REDIS_PORT=6379
REDIS_PASSWORD=

JWT配置：

JWT_SECRET=your-secret-key-at-least-32-characters-long
JWT_EXPIRES_IN=7200

安装依赖并启动

pnpm install
pnpm run start:dev

启动成功标志：

[Nest] LOG [NestApplication] Nest application successfully started
Application is running on: http://localhost:8000

快速验证

接口文档

访问 Swagger 文档：

http://localhost:8000/api

登录测试

使用 Swagger 或 curl 测试登录接口：

curl -X POST http://localhost:8000/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username":"admin","password":"123456"}'

成功响应：

{
  "code": "00000",
  "msg": "成功",
  "data": {
    "accessToken": "eyJhbGc...",
    "refreshToken": "eyJhbGc...",
    "tokenType": "Bearer",
    "expiresIn": 7200
  }
}

前端联调

克隆前端项目

git clone https://gitee.com/youlaiorg/vue3-element-admin.git
cd vue3-element-admin

配置后端地址

修改 .env.development：

VITE_APP_API_URL=http://localhost:8000

启动前端

pnpm install
pnpm run dev

访问 http://localhost:5173，使用以下账号登录：

• 用户名：admin
• 密码：123456

常见问题

端口冲突

解决方案：修改 .env 中的 PORT

数据库连接失败

排查步骤：

1. 确认 MySQL 服务已启动
2. 检查数据库连接配置
3. 确认数据库 youlai_admin 已创建

Redis 连接失败

排查步骤：

1. 确认 Redis 服务已启动：redis-cli ping
2. 检查 Redis 连接配置

下一步

• 部署运维 - 生产环境部署指南
• 认证机制 - 登录认证与会话管理
• 数据权限 - 数据权限配置