快速创建 Platform Project 项目的脚手架工具,基于 Vue 3 + Vite + Element Plus 的项目模板。
无需安装,直接使用 npx 命令:
npx create-platform-project my-projectnpx create-platform-project <project-name>project-name: 项目名称(只能包含小写字母、数字和连字符)
# 创建名为 my-app 的项目
npx create-platform-project my-app
# 进入项目目录
cd my-app
# 安装依赖
pnpm install
# 启动开发服务器
pnpm dev创建的项目包含以下特性:
- ⚡️ Vue 3 - 使用 Composition API 和
<script setup>语法 - 🚀 Vite - 极速的开发体验
- 🎨 Element Plus - 企业级 UI 组件库
- 📦 Pinia - 新一代状态管理库,支持持久化
- 🛣️ Vue Router - 官方路由管理器
- 🔧 自动导入 - 自动导入组件和 API,无需手动 import
- 📝 代码规范 - ESLint + Prettier + Husky
- 🧪 测试支持 - Vitest + Mock 工具
- ⚛️ JSX 支持 - 支持使用 JSX 语法编写组件
- 📊 ECharts 支持 - 集成 ECharts 5.x,提供封装好的图表组件
- 🔐 权限管理 - 内置权限指令和权限管理功能
- 📡 HTTP 封装 - 统一的请求拦截和错误处理
- 🌐 WebSocket 支持 - 内置 WebSocket 工具类
- 📦 版本管理 - 自动版本更新和检测功能
- 🎨 主题定制 - 支持系统、头部、菜单主题自定义
脚手架会自动替换模板文件中的 {{project-name}} 占位符为实际的项目名称,包括:
package.json中的name字段.env.*文件中的VITE_APP_TITLEREADME.md文件index.html文件- 其他所有文本文件中的占位符
- Node.js: >= 18.0.0
- pnpm: >= 9.0.0
⚠️ 重要提示:生成的项目必须使用pnpm进行依赖安装,不支持npm或yarn。
如果尚未安装 pnpm,可以通过以下方式安装:
# 使用 npm 安装(仅用于安装 pnpm)
npm install -g pnpm
# 或使用 Corepack(Node.js 16.13+ 自带)
corepack enable
corepack prepare pnpm@latest --activate如果你想参与开发此脚手架工具:
# 克隆仓库
git clone <repository-url>
# 进入项目目录
cd jrd-platform
# 安装依赖(如果需要)
npm install
# 测试本地开发
node bin/create-platform-project.js test-projectjrd-platform/
├── bin/ # 脚手架脚本
│ └── create-platform-project.js
├── template/ # 项目模板
│ ├── src/ # 源代码目录
│ ├── public/ # 静态资源
│ ├── package.json # 项目配置
│ └── ...
└── package.json # 脚手架配置
ISC