更新 readme.md
This commit is contained in:
parent
262bf41379
commit
4e4951cc00
91
README.md
91
README.md
|
|
@ -1,40 +1,6 @@
|
|||
<div align="center">
|
||||
<img alt="vue3-element-admin" width="80" height="80" src="./src/assets/logo.png">
|
||||
<h1>vue3-element-admin</h1>
|
||||
|
||||
<img src="https://img.shields.io/badge/Vue-3.5.13-brightgreen.svg"/>
|
||||
<img src="https://img.shields.io/badge/Vite-6.0.5-green.svg"/>
|
||||
<img src="https://img.shields.io/badge/Element Plus-2.9.1-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"/>
|
||||
</a>
|
||||
|
||||
<a href="https://gitee.com/youlaiorg/youlai-boot" target="_blank">
|
||||
<img alt="有来技术" src="https://gitee.com/youlaiorg/vue3-element-admin/badge/star.svg"/>
|
||||
</a>
|
||||
<a href="https://github.com/youlaitech/vue3-element-admin" target="_blank">
|
||||
<img alt="有来技术" src="https://img.shields.io/github/stars/youlaitech/vue3-element-admin.svg?style=social&label=Stars"/>
|
||||
</a>
|
||||
<a href="https://gitcode.com/youlai/vue3-element-admin" target="_blank">
|
||||
<img alt="有来技术" src="https://gitcode.com/youlai/vue3-element-admin/star/badge.svg"/>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<div align="center">
|
||||
<a target="_blank" href="http://vue3.youlai.tech">🔍 在线预览</a> | <a target="_blank" href="https://juejin.cn/post/7228990409909108793">📖 阅读文档</a> | <a href="./README.en-US.md">🌐English
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
## 项目简介
|
||||
|
||||
[vue3-element-admin](https://gitcode.com/youlai/vue3-element-admin) 是基于 Vue3 + Vite5+ TypeScript5 + Element-Plus + Pinia 等主流技术栈构建的免费开源的中后台管理的前端模板（配套[Java 后端源码](https://gitee.com/youlaiorg/youlai-boot)）。
|
||||
|
||||
[vue3-element-admin](https://gitcode.com/youlai/vue3-element-admin) 是基于 Vue3 + Vite5+ TypeScript5 + Element-Plus + Pinia 等主流技术栈构建的免费开源的中后台管理的前端模板
|
||||
|
||||
## 项目特色
|
||||
|
||||
|
|
@ -48,8 +14,6 @@
|
|||
|
||||
- **持续更新**：项目持续开源更新，实时更新工具和依赖。
|
||||
|
||||
|
||||
|
||||
## 项目预览
|
||||
|
||||
|
||||
|
|
@ -58,13 +22,12 @@
|
|||
|
||||
|
||||
|
||||
## 项目源码
|
||||
## 项目参考源码
|
||||
|
||||
| 项目 | Gitee | Github | GitCode|
|
||||
| ---- | ----| ---- | ---- |
|
||||
| 前端 | [vue3-element-admin](https://gitee.com/youlaiorg/vue3-element-admin) | [vue3-element-admin](https://github.com/youlaitech/vue3-element-admin) | [vue3-element-admin](https://gitcode.com/youlai/vue3-element-admin) |
|
||||
| 精简版 | [vue3-element-template](https://gitee.com/youlaiorg/vue3-element-template) | [vue3-element-template](https://github.com/youlaitech/vue3-element-template) |-|
|
||||
| 后端 | [youlai-boot](https://gitee.com/youlaiorg/youlai-boot) | [youlai-boot](https://github.com/haoxianrui/youlai-boot.git) |[youlai-boot](https://gitcode.com/youlai/youlai-boot.git)|
|
||||
|
||||
## 环境准备
|
||||
|
||||
|
|
@ -73,7 +36,6 @@
|
|||
| **开发工具** | VSCode | [下载](https://code.visualstudio.com/Download) |
|
||||
| **运行环境** | Node ≥18 (其中 20.6.0 版本不可用) | [下载](http://nodejs.cn/download) |
|
||||
|
||||
|
||||
## 项目启动
|
||||
|
||||
```bash
|
||||
|
|
@ -96,8 +58,6 @@ pnpm install
|
|||
pnpm run dev
|
||||
```
|
||||
|
||||
|
||||
|
||||
## 项目部署
|
||||
|
||||
```bash
|
||||
|
|
@ -109,17 +69,17 @@ pnpm run build
|
|||
|
||||
# nginx.cofig 配置
|
||||
server {
|
||||
listen 80;
|
||||
server_name localhost;
|
||||
location / {
|
||||
root /usr/share/nginx/html;
|
||||
index index.html index.htm;
|
||||
}
|
||||
# 反向代理配置
|
||||
location /prod-api/ {
|
||||
listen 80;
|
||||
server_name localhost;
|
||||
location / {
|
||||
root /usr/share/nginx/html;
|
||||
index index.html index.htm;
|
||||
}
|
||||
# 反向代理配置
|
||||
location /prod-api/ {
|
||||
# api.youlai.tech 替换后端API地址，注意保留后面的斜杠 /
|
||||
proxy_pass http://api.youlai.tech/;
|
||||
}
|
||||
proxy_pass http://api.youlai.tech/;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -129,12 +89,7 @@ server {
|
|||
|
||||
## 后端接口
|
||||
|
||||
> 如果您具备Java开发基础，按照以下步骤将在线接口转为本地后端接口，创建企业级前后端分离开发环境，助您走向全栈之路。
|
||||
|
||||
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. 修改 `.env.development` 文件中的 `VITE_APP_API_URL` 的值，将其从 https://api.youlai.tech 更改为 http://localhost:8989 即可。
|
||||
|
||||
1. 修改 `.env.development` 文件中的 `VITE_APP_API_URL` 的值，将其从 <https://api.youlai.tech> 更改为 <http://localhost:8989> 即可。
|
||||
|
||||
## 注意事项
|
||||
|
||||
|
|
@ -154,14 +109,12 @@ server {
|
|||
|
||||
- **项目组件、函数和引用爆红**
|
||||
|
||||
重启 VSCode 尝试
|
||||
重启 VSCode 尝试
|
||||
|
||||
- **其他问题**
|
||||
|
||||
如果有其他问题或者建议，建议 [ISSUE](https://gitee.com/youlaiorg/vue3-element-admin/issues/new)
|
||||
|
||||
|
||||
|
||||
## 项目文档
|
||||
|
||||
- [基于 Vue3 + Vite + TypeScript + Element-Plus 从0到1搭建后台管理系统](https://blog.csdn.net/u013737132/article/details/130191394)
|
||||
|
|
@ -169,19 +122,16 @@ server {
|
|||
- [ESLint+Prettier+Stylelint+EditorConfig 约束和统一前端代码规范](https://blog.csdn.net/u013737132/article/details/130190788)
|
||||
- [Husky + Lint-staged + Commitlint + Commitizen + cz-git 配置 Git 提交规范](https://blog.csdn.net/u013737132/article/details/130191363)
|
||||
|
||||
|
||||
## 提交规范
|
||||
|
||||
执行 `pnpm run commit` 唤起 git commit 交互，根据提示完成信息的输入和选择。
|
||||
|
||||
|
||||
|
||||
|
||||
## 项目统计
|
||||
|
||||
|
||||
|
||||
|
||||
Thanks to all the contributors!
|
||||
|
||||
[](https://github.com/youlaitech/vue3-element-admin/graphs/contributors)
|
||||
|
|
@ -189,16 +139,3 @@ Thanks to all the contributors!
|
|||
## G-Star
|
||||
|
||||
|
||||
|
||||
## 交流群🚀
|
||||
|
||||
> **关注「有来技术」公众号，获取交流群二维码。**
|
||||
>
|
||||
> 如果交流群的二维码过期，请加微信(haoxianrui)并备注「前端」、「后端」或「全栈」以获取最新二维码。
|
||||
>
|
||||
> 为确保交流群质量，防止营销广告人群混入，我们采取了此措施。望各位理解！
|
||||
|
||||
| 公众号 | 交流群 |
|
||||
|:----:|:----:|
|
||||
|  |  |
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue