# youlai-nest
**Repository Path**: youlaiorg/youlai-nest
## Basic Information
- **Project Name**: youlai-nest
- **Description**: 🌈 基于 Node.js、NestJS、TypeORM、Vite 构建的企业级权限管理后端，是 vue3-element-admin 配套的官方 Node.js 实现。
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://vue.youlai.tech
- **GVP Project**: No
## Statistics
- **Stars**: 114
- **Forks**: 61
- **Created**: 2024-08-29
- **Last Updated**: 2026-04-18
## Categories & Tags
**Categories**: Uncategorized
**Tags**: Nestjs, Nodejs, Redis, MySQL
## README
🖥️ 在线预览
|
📑 阅读文档
|
🌐 官网
## 📢 项目简介
`youlai-nest` 是 `vue3-element-admin` 配套的 Node.js 后端实现，基于 NestJS 11, TypeScript, TypeORM, JWT, Redis, MySQL 构建，是 **youlai 全家桶** 的重要组成部分。
- **🚀 企业级框架**: 基于 NestJS 11，提供稳定、可扩展的后端架构。
- **🔐 双重认证**: 支持 JWT 和 Redis Token 两种会话模式，可根据业务需求灵活切换。
- **🔑 权限管理**: 内置基于 RBAC 的权限模型，精确控制接口和按钮权限。
- **🛠️ 功能模块**: 包含用户、角色、菜单、部门、字典等后台管理系统的核心功能。
## 🌈 项目源码
| 项目类型 | Gitee | Github | GitCode |
| --------------- | -------------------------------------------------------------------- | ---------------------------------------------------------------------- | ------------------------------------------------------------------- |
| ✅ Node.js 后端 | [youlai-nest](https://gitee.com/youlaiorg/youlai-nest) | [youlai-nest](https://github.com/youlaitech/youlai-nest) | [youlai-nest](https://gitcode.com/youlai/youlai-nest) |
| vue3 前端 | [vue3-element-admin](https://gitee.com/youlaiorg/vue3-element-admin) | [vue3-element-admin](https://github.com/youlaitech/vue3-element-admin) | [vue3-element-admin](https://gitcode.com/youlai/vue3-element-admin) |
| uni-app 移动端 | [youlai-app](https://gitee.com/youlaiorg/youlai-app) | [youlai-app](https://github.com/youlaitech/youlai-app) | [youlai-app](https://gitcode.com/youlai/youlai-app) |
## 📚 项目文档
| 文档名称 | 访问地址 |
| ------------------ | ---------------------------------------------------------------------------------------------------- |
| 项目介绍与使用指南 | [https://www.youlai.tech/docs/admin/backend/node/](https://www.youlai.tech/docs/admin/backend/node/) |
## 📁 项目目录
```text
youlai-nest/
├─ src/ # 核心业务源码
│ ├─ main.ts # 应用入口
│ ├─ app.module.ts # 根模块
│ ├─ auth/ # 认证与鉴权模块
│ ├─ system/ # 系统核心模块（用户/角色/菜单/部门等）
│ ├─ codegen/ # 代码生成模块
│ ├─ file/ # 文件管理模块
│ ├─ message/ # SSE 消息推送
│ ├─ common/ # 公共能力（守卫/拦截器/过滤器/常量/枚举/异常/工具类等）
│ ├─ config/ # 配置文件
│ └─ types/ # 类型定义
├─ sql/ # 数据库脚本
├─ .env # 基础环境配置
├─ .env.dev # 开发环境配置
├─ .env.prod # 生产环境配置
└─ package.json # 项目配置与脚本
```
## 🚀 快速启动
### 1. 环境准备
| 要求 | 说明 |
| ----------- | ------------ |
| **Node.js** | 20+ / 24 LTS |
| **pnpm** | 包管理器 |
| **MySQL** | 5.7+ 或 8.x |
| **Redis** | 7.x 稳定版 |
> ⚠️ **重要提示**：MySQL 与 Redis 为项目启动必需依赖，请确保服务已启动。
### 2. 数据库初始化
推荐使用 **Navicat**、**DBeaver** 或 **MySQL Workbench** 执行 `sql/mysql/youlai_admin.sql` 脚本，完成数据库和基础数据的初始化。
### 3. 修改配置
根据 `.env.example` 创建 `.env.dev` 和 `.env.prod` 文件，并根据实际情况修改 MySQL 和 Redis 的连接信息。
### 4. 启动项目
```bash
# 安装依赖
pnpm install
# 启动开发环境
pnpm run start:dev
```
启动成功后，访问 [http://localhost:8000/api-docs](http://localhost:8000/api-docs) 验证项目是否成功。
## 🐳 项目部署
### 1. 原生部署
```bash
# 构建
pnpm run build
# 启动
pnpm run start:prod
```
### 2. Docker 部署
```bash
# 构建并启动容器
docker compose up -d --build
```
## 💖 技术交流
① 关注「有来技术」公众号，点击菜单 **交流群** 获取加群二维码（此举防止广告进群，
感谢理解和支持）。
② 直接添加微信 **`haoxianrui`** 备注「前端/后端/全栈」。
