脚手架使用文档
脚手架使用文档
一、前端 使用说明
简介
msp-vue3 是一个基于 Vue3、Vite、TypeScript、AntDesignVue、Pinia 和 UnoCSS 的后台管理系统。
chart选用的是echarts；
请求用的是axios；
如果你在使用本项目之前，对这些依赖有一定了解，那会大大提高您的开发效率。
关于组件
项目虽然二次封装了一些组件，但是可能不能满足您的产品开发需求。
所以，如果组件不满足你的要求，可自开发相应组件并期待您共享于脚手架，不必坚持使用项目自带的组件。
环境准备
本地环境需要安装 pnpm、Node.js 和 Git
推荐使用pnpm，否则依赖可能安装不上。
Node.js 版本要求16.x以上，这里推荐 20.x 及以上。
推荐安装 nvm 来管理 Node.js 版本。
工具配置
如果您使用的 IDE 是vscode(推荐)的话，可以安装以下工具来提高开发效率及代码格式化
Iconify IntelliSense - Iconify 图标插件
windicss IntelliSense - windicss 提示插件
I18n-ally - i18n 插件
Volar - vue 开发必备
ESLint - 脚本代码检查
Prettier - 代码格式化
Stylelint - css 格式化
DotENV - .env 文件 高亮
TypeScript Vue Plugin (Volar) - 用于让 TS 识别 *.vue 文件。
代码获取注意事项
1.存放代码的目录及所有父级目录不能存在中文、韩文、日文以及空格，否则安装依赖后启动可能会出错。
2.使用Volar的同时，请禁用Vetur，然后重启vscode，因为本项目依赖vue3。
二、 安装使用
获取项目代码
1.下载代码（外网需连接公司vpn）
http://nexus.juneyaoair.com:8081/repository/npm-releases/msp-vue3/-/msp-vue3-1.0.0.tgz
2.解压缩
使用解压工具进行解压
3.安装依赖
cd msp-vue3
npm install
# 或者
pnpm install
4.运行
npm run dev
# 或者
pnpm dev
测试环境打包
npm run build:test
# 或者
pnpm build:test
正式环境打包
npm run build
# 或者
pnpm build
npm script说明
"scripts": {
_#安装依赖_"bootstrap": "pnpm install",
_#运行项目_"serve": "npm run dev",
"dev": "vite --open",
_# 构建项目_"build:test": "vite build --mode test",
"build": "vite build --mode production",
_# 预览打包后的内容（先打包在进行预览）_"preview": "npm run build && vite preview",
"preview:dist": "vite preview",
"deploy": "bash deploy.sh",
_#删除node_modules缓存_"clean:cache": "npx rimraf node_modules/.cache/ && npx rimraf node_modules/.vite",
_#删除node_modules文件夹_"clean:lib": "npx rimraf node_modules",
_# 执行 prettier 格式化（该命令会对项目所有代码进行 prettier 格式化，请谨慎执行）_"format": "prettier --write .",
_#eslint_"lint": "eslint . --ext .vue,.js,.ts,.jsx,.tsx,.md,.json --max-warnings 0 && pretty-quick --check --branch main",
_#eslint修复_"lint:fix": "eslint --fix . --ext .vue,.js,.ts,.jsx,.tsx,.md,.json && pretty-quick --branch main",
_# 执行 eslint 校验，并修复部分问题_"lint:eslint": "eslint --cache --max-warnings 0 \"{src,mock}/**/*.{vue,ts,tsx}\" --fix",
_# 执行 stylelint 格式化_"lint:stylelint": "stylelint --cache --fix \"**/*.{vue,less,postcss,css,scss}\" --cache --cache-location node_modules/.cache/stylelint/",
_# 可配置指定文件娇艳_"lint:lint-staged": "lint-staged",
_# 安装git hooks_"prepare": "husky install",
_# 重新安装依赖_"reinstall": "rimraf pnpm-lock.yaml && rimraf package.lock.json && rimraf node_modules && npm run bootstrap",
_# 对打包结果进行 gzip 测试_"test:gzip": "npx http-server dist --cors --gzip -c-1",
_# 对打包结果进行 br 测试_"test:br": "npx http-server dist --cors --brotli -c-1",
_# sonar_"sonar": "sonar-scanner"
},
env环境配置文件说明
.env.test文件对应test环境
.env.production对应正式环境
目录说明
├── mock _# mock文件夹_
├── public _# 公共静态资源目录_
├── src _# 主目录_
│ ├── api _# 接口文件_
│ ├── assets _# 资源文件_
│ │ ├── icons _# icon sprite 图标文件夹_
│ │ ├── images _# 项目存放图片的文件夹_
│ ├── components _# 公共组件_
│ ├── core _# 核心功能_
│ │ ├── permission _# 权限_
│ ├── directives _# 指令_
│ ├── enums _# 枚举/常量_
│ ├── hooks _# hook_
│ │ ├── event _# 事件相关hook_
│ │ └── useModal _# modal相关hook_
│ ├── layouts _# 布局文件_
│ │ ├── footer _# 底部_
│ │ ├── header _# 头部_
│ │ └── logo _# 左上角logo_
│ │ └── menu _# 左侧菜单_
│ │ └── routerView _# 中间展示区_
│ │ └── tabs _# 标签栏_
│ ├── locales _# 多语言_
│ ├── logics _# 逻辑_
│ ├── router _# 路由配置_
│ ├── store _# 数据仓库pinia_
│ ├── styles _# 样式_
│ ├── utils _# 工具类_
│ └── views _# 页面_
├── types _# ts类型文件_
└── vite.config.ts _# vite配置文件_
三、后端使用说明
简介
脚手架 是基于开源项目ruoyi的改造项目，致力于提供更多功能和性能优化。本文档将指导您快速部署和启动该项目。
环境要求
JavaScript
确保你的系统满足以下要求：
Java JDK 8
Maven 3.x 或更高版本
数据库 MySQL、Redis
私服地址
http://nexus.juneyaoair.com:8081/
系统模块
msp
├── msp-dependencies // 依赖配置
├── msp-framework // 插件组件
│ └── msp-framework-security // 安全组件
│ └── msp-framework-spring-cloud // 微服务组件
│ └── msp-framework-spring // spring组件
│ └── msp-framework-redis // redis组件
│ └── msp-framework-common // 通用组件
│ └── msp-framework-swagger // 接口文档组件
│ └── msp-framework-core // 核心组件(框架规范)
│ └── msp-framework-mybatis-plus // 数据库ORM组件
│ └── msp-framework-datasource // 多数据源组件
│ └── msp-framework-log // 日志组件
│ └── msp-framework-xxl-job // xxl调度组件
├── msp-business // 功能模块
│ └── msp-api // feign接口
│ └── msp-api-boot // boot单体服务
│ └── msp-api-core // 核心功能
│ └── msp-api-cloud // 微服务功能
│ └── msp-auth // 权限模块
│ └── msp-file // 文件模块
│ └── msp-gateway // 网关模块
│ └── msp-system // 系统模块
集成使用
msp脚手架parent pom依赖
<!--parent pom依赖 -->
<parent>
<groupId>com.juneyaoair.msp</groupId>
<artifactId>msp</artifactId>
<version>1.0.0</version>
</parent>
msp-framework模块（按需依赖）
<!-- 安全组件 -->
<dependency>
<groupId>com.juneyaoair.msp.framework</groupId>
<artifactId>msp-framework-security</artifactId>
</dependency>
<!-- 微服务组件 -->
<dependency>
<groupId>com.juneyaoair.msp.framework</groupId>
<artifactId>msp-framework-spring-cloud</artifactId>
</dependency>
<!-- redis组件-->
<dependency>
<groupId>com.juneyaoair.msp.framework</groupId>
<artifactId>msp-framework-redis</artifactId>
</dependency>
<!-- 通用组件-->
<dependency>
<groupId>com.juneyaoair.msp.framework</groupId>
<artifactId>msp-framework-common</artifactId>
</dependency>
<!-- 接口文档组件-->
<dependency>
<groupId>com.juneyaoair.msp.framework</groupId>
<artifactId>msp-framework-swagger</artifactId>
</dependency>
<!-- 核心组件(框架规范)-->
<dependency>
<groupId>com.juneyaoair.msp.framework</groupId>
<artifactId>msp-framework-core</artifactId>
</dependency>
<!-- 数据库ORM组件-->
<dependency>
<groupId>com.juneyaoair.msp.framework</groupId>
<artifactId>msp-framework-mybatis-plus</artifactId>
</dependency>
<!-- 多数据源组件-->
<dependency>
<groupId>com.juneyaoair.msp.framework</groupId>
<artifactId>msp-framework-datasource</artifactId>
</dependency>
<!-- 日志组件-->
<dependency>
<groupId>com.juneyaoair.msp.framework</groupId>
<artifactId>msp-framework-log</artifactId>
</dependency>
<!-- xxl调度组件-->
<dependency>
<groupId>com.juneyaoair.msp.framework</groupId>
<artifactId>msp-framework-xxl-job</artifactId>
</dependency>
msp-business功能模块（按需依赖）
msp-api feign接口（按需依赖）
<!-- 核心功能-->
<dependency>
<groupId>com.juneyaoair.msp.framework</groupId>
<artifactId>msp-api-core</artifactId>
</dependency>
<!-- boot单体服务-->
<dependency>
<groupId>com.juneyaoair.msp.framework</groupId>
<artifactId>msp-api-boot</artifactId>
</dependency>
<!-- 微服务功能-->
<dependency>
<groupId>com.juneyaoair.msp.framework</groupId>
<artifactId>msp-api-cloud</artifactId>
</dependency>
权限模块（按需依赖）
<dependency>
<groupId>com.juneyaoair.msp.framework</groupId>
<artifactId>msp-auth</artifactId>
</dependency>
文件模块（按需依赖）
<dependency>
<groupId>com.juneyaoair.msp.framework</groupId>
<artifactId>msp-file</artifactId>
</dependency>
网关模块（按需依赖）
<dependency>
<groupId>com.juneyaoair.msp.framework</groupId>
<artifactId>msp-gateway</artifactId>
</dependency>
系统模块（按需依赖）
<dependency>
<groupId>com.juneyaoair.msp.framework</groupId>
<artifactId>msp-system</artifactId>
</dependency>