开始

本文将快速的帮助你从头运行并启动项目。

环境准备

本地环境需要安装 npm、Node.js 和 Git

注意

• Node.js 版本要求18.x以上，这里推荐 18.12.1 及以上。

工具配置

如果你使用的 IDE 是vscode的话，可以安装以下工具来提高开发效率及代码格式化：

• Iconify IntelliSense - Iconify 图标插件
• unocss - unocss 提示插件
• I18n-ally - i18n 插件
• Volar - vue 开发必备
• ESLint - 脚本代码检查
• Prettier - 代码格式化
• Stylelint - css 格式化
• DotENV - .env 文件 高亮

代码获取

注意

注意存放代码的目录及所有父级目录不能存在中文、韩文、日文以及空格，否则安装依赖后启动会出错。

从 GitHub 获取代码

# clone 代码
git clone https://github.com/syh-micro-build/mb-admin.git

安装

安装 Node.js

如果您电脑未安装Node.js，请安装它，推荐 18.x 及以上

验证

# 验证 npm 是否安装成功
npm -v

# 验证 node 是否安装成功
node -v

如果你需要同时存在多个 node 版本，可以使用 Nvm 或者其他工具进行 Node.js 进行版本管理。

安装依赖

在项目根目录下，打开命令窗口执行，耐心等待安装完成即可

# 安装依赖
npm i

安装依赖时 husky 安装失败

请查看你的源码是否从 Github 直接下载的，直接下载是没有 .git 文件夹的，而 husky 需要依赖 git 才能安装。此时需使用 git init 初始化项目，再尝试重新安装即可。

当依赖安装完成后，执行以下命令即可启动项目：

npm run dev

npm script

"scripts": {
  // 本地开发环境运行
  "dev": "vite --mode base --host",
  // 指定环境打包 (dev, test, pro)，例如：npm run build pro
  "build": "run-p type-check \"build-only -- --mode {1}\" --",
  // 本地预览 (dev, test, pro)，例如：npm run preview pro
  "preview": "vite preview --mode",
  // 仅打包 (可忽略)
  "build-only": "vite build",
  // 类型检查
  "type-check": "vue-tsc --build",
  // 代码规范检查
  "lint": "eslint . --fix \"src/**/*.{js,ts,tsx,vue,html}\"",
  // 代码格式化
  "format": "prettier --write --loglevel warn \"src/**/*.{js,ts,json,tsx,css,less,vue,html,md}\"",
  // 样式规范检查
  "style": "stylelint --fix \"**/*.{vue,less,postcss,css,scss}\" --cache --cache-location node_modules/.cache/stylelint/",
  // 单元测试
  "test:unit": "vitest",
  // husky 初始化
  "prepare": "husky",
  // 快速生成统一规范的模块
  "plop": "plop",
  // 检测可更新依赖
  "npm-check": "npx npm-check-updates -i --format group",
  // 标准版本发布
  "release": "standard-version"
},