# nova-admin **Repository Path**: rhyanne/nova-admin ## Basic Information - **Project Name**: nova-admin - **Description**: A modern admin dashboard built with Vue 3 and Vite, offering a clean UI, RBAC, and easy customization for rapid backend management. - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-11-11 - **Last Updated**: 2026-11-14 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # Nova Admin 通用后台管理系统脚手架,采用 pnpm + Turbo monorepo 组织,前后端分离,内置完整的 RBAC 权限体系与 AI 智能助手示例。 ## 技术栈 | 端 | 技术 | | ------------------- | ----------------------------------------------------------------------------- | | 后端 `@nova/server` | NestJS 12 · Prisma 7 · PostgreSQL · JWT(access + refresh 双令牌)· bcryptjs | | 前端 `@nova/web` | Vue 3.5 · vue-router 5 · Pinia 4 · Vite 8 · Element Plus · UnoCSS · ECharts 6 | | 共享 `@nova/shared` | TypeScript 类型与常量,ESM / CJS 双格式构建 | | 工程化 | pnpm 12 · Turbo · TypeScript 5.9 · oxlint · oxfmt | ## 功能特性 - **认证授权**:登录 / 登出、refresh token 轮换、JWT 守卫 + 按钮级权限指令 - **系统管理**:用户、角色、菜单(树形)、字典、登录日志、操作日志 - **动态路由**:前端路由由后端菜单驱动,按角色下发,组件懒加载 - **仪表盘**:统计卡片、趋势图表、快捷入口 - **Agent 智能助手**:SSE 流式对话、工具调用(真实数据库查询)、会话持久化,未配置 LLM 时自动走 mock 演示模式 - **布局**:侧边栏 + 多标签页(Chrome 风格)+ 设置抽屉,支持暗色模式 ## 快速开始 ### 环境要求 - Node.js >= 22.12 - pnpm 12(可通过 `corepack enable` 启用,仓库已锁定 `pnpm@12.16.1`) - PostgreSQL(开发默认连接本地 `localhost:5432`) ### 安装与启动 ```bash # 1. 安装依赖 pnpm install # 2. 配置后端环境变量:复制 apps/server/.env.example 为 apps/server/.env # 按需修改 DATABASE_URL,生产环境务必替换 JWT 密钥 # 3. 确保 PostgreSQL 已启动,并创建数据库(默认 nova_admin) # 4. 生成 Prisma Client、执行迁移与种子数据 pnpm --filter @nova/server db:generate pnpm db:migrate pnpm db:seed # 5. 启动前后端(Turbo 会自动先构建 shared 包) pnpm dev ``` 启动后访问: - 前端:http://localhost:5173(`/api` 已代理到后端) - 后端:http://localhost:3000/api ### 默认账号 | 账号 | 密码 | 角色 | | ------- | ---------- | ----------------------------------- | | `admin` | `admin123` | 超级管理员(全部权限) | | `demo` | `demo123` | 普通用户(仪表盘、Agent、个人中心) | ## 环境变量 配置位于 `apps/server/.env`(参考 `.env.example`): | 变量 | 说明 | 默认 | | -------------------------------------------- | ----------------------------------------------------- | ------------------------------------------------------------------------ | | `DATABASE_URL` | PostgreSQL 连接串 | `postgresql://postgres:postgres@localhost:5432/nova_admin?schema=public` | | `PORT` | 后端端口 | `3000` | | `JWT_ACCESS_SECRET` / `JWT_REFRESH_SECRET` | JWT 签名密钥,生产环境务必替换为强随机串 | `change-me-*` | | `JWT_ACCESS_EXPIRES` / `JWT_REFRESH_EXPIRES` | 令牌有效期 | `2h` / `7d` | | `LLM_BASE_URL` | OpenAI 兼容接口地址,如 `https://api.deepseek.com/v1` | 空(mock 模式) | | `LLM_API_KEY` | LLM API Key,留空时 Agent 使用 mock 流式回复 | 空 | | `LLM_MODEL` | 模型名,如 `deepseek-chat` | `gpt-4o-mini` | ## 常用命令 根目录执行: | 命令 | 说明 | | ---------------------------------- | ------------------------------------ | | `pnpm dev` | 启动前后端开发服务 | | `pnpm dev:web` / `pnpm dev:server` | 单独启动前端 / 后端 | | `pnpm build` | 构建全部包(产物在各包 `dist/`) | | `pnpm typecheck` | 全部包类型检查 | | `pnpm lint` / `pnpm lint:fix` | oxlint 检查 / 自动修复 | | `pnpm db:migrate` | 开发环境迁移(`prisma migrate dev`) | | `pnpm db:seed` | 写入种子数据(幂等,可重复执行) | | `pnpm format` | oxfmt 格式化 | | `pnpm format:check` | oxfmt 格式检查(不写入) | 后端包内另有:`db:generate`(生成 Prisma Client)、`db:deploy`(生产迁移)、`db:studio`(Prisma Studio)。 ### Git 提交钩子 `pnpm install` 后自动启用 husky(`prepare` 脚本)。提交时 lint-staged 仅对暂存文件执行 `oxlint --fix` 与 `oxfmt`,可修复问题自动修复并重新暂存,不可修复的错误会阻断提交。 ### CI 流水线 `.workflow/CI.yml` 定义 Gitee Go 流水线:push / PR 到 master 时自动执行依赖安装、Prisma Client 生成、lint、格式检查、类型检查与构建。开通方式、配置讲解与失败排查见 [docs/gitee-go-ci.md](docs/gitee-go-ci.md)。 ## 项目结构 ``` ├── apps/ │ ├── server/ # NestJS 后端 │ │ ├── prisma/ # schema.prisma、seed.ts │ │ └── src/ │ │ ├── common/ # 守卫、装饰器、拦截器、异常过滤器、工具 │ │ ├── modules/ # auth / users / roles / menus / dicts / logs / dashboard / agent │ │ ├── prisma/ # PrismaModule / PrismaService │ │ └── generated/ # Prisma Client(生成代码,已 gitignore) │ └── web/ # Vue 3 前端 │ └── src/ │ ├── api/ # axios 封装(令牌自动刷新)与各模块接口 │ ├── layouts/ # 侧边栏、头部、多标签页、设置抽屉 │ ├── pages/ # 页面(登录、403/404 走文件路由,业务页走后端动态路由) │ ├── router/ # 路由与守卫 │ ├── stores/ # app / auth / route / tab │ └── components/ # 通用组件 ├── packages/ │ └── shared/ # 共享类型与常量(ESM + CJS) ├── .workflow/ # Gitee Go CI 流水线 ├── docs/ # 操作手册 ├── turbo.json # Turbo 任务编排 └── pnpm-workspace.yaml ``` ## Agent 智能助手 - 协议:SSE 流式事件(`conversation` / `delta` / `tool_call` / `tool_result` / `done` / `error`) - 内置工具(命中真实数据库):`get_system_stats` 系统统计、`get_current_time` 服务器时间、`query_users` 用户查询、`create_user` 创建用户(需 `system:user:create` 权限,密码可选、缺省自动生成,明文仅实时展示一次、落库脱敏,操作写入审计日志) - 未配置 `LLM_API_KEY` 时为 mock 演示模式,可体验完整流式与工具调用流程;配置后支持 DeepSeek / 通义 / Kimi / OpenAI 等兼容接口 - 会话与消息持久化到 PostgreSQL,按用户隔离 ## 生产构建 ```bash pnpm build pnpm --filter @nova/server db:deploy # 生产数据库迁移 node apps/server/dist/main.js # 启动后端 ``` 前端产物 `apps/web/dist/` 为纯静态文件,部署到 Nginx / CDN 并将 `/api` 反向代理到后端即可。