vben-quick-start.mdc 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. ---
  2. description: 项目启动
  3. globs:
  4. alwaysApply: false
  5. ---
  6. # Vben 项目快速启动
  7. ## 环境要求
  8. - Node.js 20.15.0 及以上版本 (推荐使用 `fnm` 或 `nvm` 进行版本管理)
  9. - Git 任意版本
  10. 检查命令:
  11. `node -v`
  12. `git -v`
  13. ## 启动项目
  14. ### 1. 获取源码
  15. ```sh
  16. # 克隆 GitHub 仓库
  17. git clone https://github.com/vbenjs/vue-vben-admin.git
  18. # 或者克隆 Gitee 仓库 (可能不是最新的)
  19. git clone https://gitee.com/annsion/vue-vben-admin.git
  20. ```
  21. **注意**: 存放代码的目录及所有父级目录不能存在中文、韩文、日文以及空格。
  22. ### 2. 安装依赖
  23. 进入项目根目录 (例如 `vue-vben-admin`) 后执行:
  24. ```sh
  25. # 启用项目指定的 pnpm 版本
  26. corepack enable
  27. # 安装依赖 (项目只支持 pnpm)
  28. pnpm install
  29. ```
  30. ### 3. 运行项目
  31. ```sh
  32. # 启动项目 (会提示选择子项目)
  33. pnpm dev
  34. ```
  35. 之后,可以选择要运行的子项目,例如 `@vben/web-ele`。
  36. 访问 `http://localhost:5555` 查看。
  37. #### 直接运行指定项目
  38. ```sh
  39. pnpm run dev:antd
  40. pnpm run dev:ele
  41. pnpm run dev:naive
  42. pnpm run dev:docs
  43. pnpm run dev:play
  44. ```
  45. 相关文件:
  46. - 项目依赖管理: [pnpm-workspace.yaml](mdc:pnpm-workspace.yaml)
  47. - Turbo Repo 配置: [turbo.json](mdc:turbo.json)
  48. - 包管理: [package.json](mdc:package.json)