GVRAY Admin

🚀 基于 NestJS 11、TypeScript、Prisma、MySQL、Redis 构建的企业级后台管理脚手架，内置 RBAC 权限管理、JWT 认证、Swagger/OpenAPI、Docker 部署 与 AI 开发支持，可直接作为企业后台项目的 Starter Template。

• 🔐 RBAC 权限体系 —— 动态权限扫描、菜单权限、API 权限、权限缓存，开箱即用
• 🛡️ JWT 双 Token 认证 —— Access Token / Refresh Token、Passport、bcrypt 密码加密
• ⚡ Redis 深度集成 —— 会话管理、在线用户、接口限流、分布式锁、Pub/Sub、声明式缓存
• 🏗️ NestJS 11 + TypeScript —— 模块化架构、依赖注入、严格类型检查
• 📝 Prisma 6 ORM —— 类型安全查询，Migration / Seed / 事务全支持
• 📄 Swagger / OpenAPI —— 自动生成文档，Bearer Token 在线调试
• 🏢 组织架构 —— 用户 / 角色 / 部门 / 岗位完整体系
• 🔑 多方式登录 —— 用户名、邮箱、手机号、User ID
• 🛡️ 安全防护 —— CORS、统一异常、参数校验、日志脱敏、密码哈希
• 🐳 Docker 优先 —— 开发 / 测试 / 生产三套配置，支持滚动更新
• 🤖 AI Ready —— 内置 CLAUDE.md 与模块化知识库，Claude Code / Cursor / Copilot 直接用
• 🎯 规范化工程 —— ESLint、Prettier、统一响应格式、完整种子数据

NestJS 11 · Prisma 6 · TypeScript 5 · MySQL 8 · Redis 6 · Swagger · Docker

• Node.js >= 20
• pnpm >= 9（Corepack 内置，corepack enable 即可）
• MySQL >= 8.0
• Redis >= 6.0
• Docker（可选）

git clone https://github.com/gvray/gvray-admin.git && cd gvray-admin

pnpm install
cp .env.example .env

# 方式一：Docker 启动 MySQL + Redis
docker compose -f docker-compose.dev.yml up -d mysql redis

# 方式二：已有本地 MySQL + Redis，配置 .env 后跳过上一步

pnpm prisma migrate dev
pnpm prisma db seed
pnpm start:dev

• 应用：http://localhost:3000
• Swagger：http://localhost:3000/api（点击 Authorize，输入 Bearer <accessToken>）

⚠️ 仅用于本地开发，请勿用于生产。

src/
├── core/       # 基础设施（decorators / guards / interceptors / filters / pipes）
├── modules/    # 业务模块（auth / system / dashboard / profile）
├── prisma/     # Prisma Module / PrismaService
├── redis/      # Redis 基础设施（缓存 / 限流 / 分布式锁）
├── shared/     # 共享层（constants / DTOs / utils / BaseService）
└── main.ts

prisma/         # Schema + 迁移 + Seed
docs/           # 项目文档
docker/         # Docker 部署配置
.claude/        # AI 知识库

📖 完整项目结构 →

普通 NestJS Starter 只给骨架，企业项目真正需要的部分还得自己搭。

• JWT 双 Token 认证
• RBAC 权限体系 + 动态扫描
• Prisma ORM + 完整 Seed
• Redis 深度集成
• Swagger / OpenAPI
• Docker 三套部署
• 用户 / 角色 / 部门 / 岗位管理
• 菜单管理
• 系统配置项
• 字典管理
• 公告通知
• 操作日志 / 登录日志
• 在线用户
• 系统监控（服务器 / 缓存）
• WebSocket 实时通知
• 定时任务
• 文件存储
• 多租户
• OpenTelemetry
• Kubernetes 部署

• CLAUDE.md — Claude Code 自动加载入口
• .claude/project/ — 按需知识库（架构 / DTO / 权限 / 响应格式）

📖 AI 开发指南 →

• gvray-react — React + Umi
• gvray-vue（开发中）— Vue 3 + Vite + Pinia + Element Plus
• gvray-vite（开发中）- React + Vite
• gvray-next（筹备中）- Nextjs

欢迎提 Issue、PR 或功能建议。如果这个项目对你有帮助，点个 ⭐ Star 是最大的支持！

本项目采用 MIT 许可证 开源。