docs: 📝 添加项目注意事项和常见问题说明

This commit is contained in:
haoxr 2023-06-03 13:26:54 +08:00
parent 0386fce902
commit 1f3e97bc3d
1 changed files with 22 additions and 5 deletions

View File

@ -1,7 +1,7 @@
<p align="center">
<img src="https://img.shields.io/badge/Vue-3.3.1-brightgreen.svg"/>
<img src="https://img.shields.io/badge/Vite-4.3.5-green.svg"/>
<img src="https://img.shields.io/badge/Element Plus-2.3.4-blue.svg"/>
<img src="https://img.shields.io/badge/Element Plus-2.3.6-blue.svg"/>
<img src="https://img.shields.io/badge/license-MIT-green.svg"/>
<a href="https://gitee.com/youlaiorg" target="_blank">
<img src="https://img.shields.io/badge/Author-有来开源组织-orange.svg"/>
@ -11,6 +11,7 @@
<a target="_blank" href="https://juejin.cn/post/7228990409909108793">vue3-element-admin官方文档</a> | <a target="_blank" href="http://vue3.youlai.tech">在线预览</a>
</p>
## 项目介绍
[vue3-element-admin](https://gitee.com/youlaiorg/vue3-element-admin) 是基于 Vue3 + Vite4+ TypeScript5 + Element-Plus + Pinia 等最新主流技术栈构建的后台管理前端模板(配套后端源码)。
@ -94,9 +95,24 @@ server {
proxy_pass http://vapi.youlai.tech/; # vapi.youlai.tech替换成你的后端API地址
}
}
```
```
## 注意事项
- **自动导入插件自动生成默认关闭**
模板项目的组件已经自动导入生成。如果您要使用新的组件,请移除相关注释以启用自动生成。在自动生成完成后,记得将其设置为 `false`,以避免重复执行和潜在冲突。
![](https://s2.loli.net/2023/06/03/lrcsHzInYV6wWqo.png)
- **项目启动浏览器访问空白**
请升级浏览器尝试,低版本浏览器内核可能不支持某些新的 JavaScript 语法,比如可选链操作符 `?.`
## 接口支持
- **接口调用地址**[https://vapi.youlai.tech](https://vapi.youlai.tech)
@ -105,8 +121,8 @@ server {
- **本地接口**:默认使用线上接口,你可以通过以下步骤完成本地接口环境搭建:
> 1. 获取基于 `Java 、SpringBoot` 开发的后端 [youlai-boot](https://gitee.com/youlaiorg/youlai-boot.git) 源码 ;
> 2. 根据后端工程说明文档 [README.md](https://gitee.com/youlaiorg/youlai-boot#%E9%A1%B9%E7%9B%AE%E8%BF%90%E8%A1%8C) 完成本地启动;
> 3. 替换 [vite.config.ts](vite.config.ts) 的代理目标地址 [vapi.youlai.tech](vapi.youlai.tech) 为本地的 [localhost:8989](localhost:8989).
>2. 根据后端工程说明文档 [README.md](https://gitee.com/youlaiorg/youlai-boot#%E9%A1%B9%E7%9B%AE%E8%BF%90%E8%A1%8C) 完成本地启动;
> 3. 替换 [vite.config.ts](vite.config.ts) 的代理目标地址 `vapi.youlai.tech` 为本地的 `localhost:8989`
@ -118,6 +134,8 @@ server {
- [Husky + Lint-staged + Commitlint + Commitizen + cz-git 配置 Git 提交规范](https://blog.csdn.net/u013737132/article/details/130191363)
## 提交规范
执行 `pnpm run commit` 唤起 git commit 交互,根据提示完成信息的输入和选择。
@ -136,4 +154,3 @@ server {
![](https://s2.loli.net/2023/05/28/7vNjHTotb2h9zBD.png)