create-dev-template
v0.2.0
Published
Create a Vue 3 + Naive UI + NestJS admin template with optional modules.
Maintainers
kk0817Readme
Dev Template
基于 Vue Naive Admin 二次整理的前后端开发模板，适合作为业务后台的起始项目。
技术栈
- 前端：Vue 3、Vite、Naive UI、Pinia、Unocss、VXE Table
- 后端：NestJS、TypeORM、MySQL、Redis
- 存储：MinIO、阿里云 OSS
已集成功能
- 登录、JWT 鉴权、Redis 登录态
- 菜单、角色、用户、按钮权限
- 接口权限管理
- 接口权限路由同步：
POST /api-permission/sync - 初始化检查：
GET /setup/check - 系统配置，支持 Redis 缓存和运行时刷新
- 登录验证码开关
- 文件上传，支持 MinIO/OSS 动态切换
- 文件管理，支持分页、预览、复制链接、删除
- 支付模块，支持开关控制、Mock/Ping++ Provider、订单、退款、回调日志
- 字典管理和前端字典组件
- 操作日志、登录日志
- 异常日志
- 定时任务和执行日志
- 在线用户管理
- 系统状态检测：MySQL、Redis、MinIO、OSS、版本和运行环境
- Swagger 接口文档：
/swagger - 布局版本号和底部版权配置
- VXE Table 通用 CRUD 表格封装
快速开始
pnpm install
pnpm dev生成新项目：
pnpm template发布到 npm 后，其他人无需克隆本仓库，可以直接执行：
pnpm create dev-template或：
pnpm dlx create-dev-template也可以直接使用预设：
pnpm create dev-template --preset payment后端：
cd server
pnpm install
pnpm start:dev默认端口：
- 前端：
3200 - 后端：
8085
初始化步骤请看 docs/INIT.md。
默认账号
- 用户名：
admin - 密码：
123456
验证码可以在系统配置中通过 LOGIN_CAPTCHA_ENABLED 控制。
常用系统配置
| 配置键 | 说明 |
| --- | --- |
| LOGIN_CAPTCHA_ENABLED | 登录验证码开关，true 开启，false 关闭 |
| UPLOAD_PROVIDER | 默认上传方式，minio 或 oss |
| OSS_REGION / OSS_ENDPOINT / OSS_BUCKET | OSS 基础连接信息 |
| OSS_DOMAIN | OSS 外网访问域名，不填时使用 SDK 返回的默认外链 |
| MINIO_DOMAIN | MinIO 外网访问域名 |
| FILE_MAX_SIZE_MB | 上传文件大小限制，单位 MB，空值表示不限制 |
| FILE_ALLOWED_TYPES | 允许上传的 MIME 类型或前缀，例如 image/,video/ |
| APP_VERSION | 左侧菜单底部版本号 |
| SHOW_COPYRIGHT | 是否显示内容区底部版权 |
| COPYRIGHT_LEFT | 底部版权左侧内容 |
| COPYRIGHT_CENTER | 底部版权中间内容 |
| COPYRIGHT_RIGHT | 底部版权右侧内容 |
| PAYMENT_ENABLED | 支付模块开关，true 开启，false 关闭 |
| PAYMENT_PROVIDER | 支付服务商，mock 或 pingxx |
| PAYMENT_MODE | 支付环境，test 或 live |
| PINGXX_APP_ID / PINGXX_TEST_API_KEY / PINGXX_LIVE_API_KEY | Ping++ 应用和密钥配置 |
文档
- 初始化说明：docs/INIT.md
- CLI 使用与发布说明：docs/CLI.md
- 后端说明：server/README.md
- 优化建议：docs/OPTIMIZATION.md
开发约定
- 前端开发环境以 Vite dev server 为准，不需要每次修改都跑前端构建。
- 后端涉及编译产物时使用
pnpm --dir server build验证。 - 数据库结构变更需要同步到
server/init.sql。 - 提交信息使用中文。
- 后端接口测试统一使用
codextester账号。
测试账号约定
- Codex 或自动化测试统一使用
codextester，不要使用admin。 codextester默认密码为123456，权限与admin同等，绑定超级管理员和质检员。admin账号保留给人工管理使用，避免测试过程影响正在使用的管理员会话。