docs: update docs

2026-01-20 16:53:37 +08:00 · 2021-04-13 18:37:47 +08:00
parent 0d1f5bb673
commit 8a8068bbab
7 changed files with 238 additions and 48 deletions
--- a/README.md
+++ b/README.md
@@ -1,67 +1,118 @@
-# Vue3.0后台管理系统
-### 功能已开发完毕（兼容移动端），新需求请提issues  
+<h1>vue-pure-admin</h1>

-vue版本代码：https://github.com/xiaoxian521/CURD-TS  
-vue版本在线地址：http://yiming_chang.gitee.io/manages  
-react版本代码：https://github.com/xiaoxian521/CURD-TS/tree/react-ts  
-angular版本代码：https://github.com/xiaoxian521/CURD-TS/tree/angular-ts  
-angular版本在线地址：http://usercxx.gitee.io/ng-gis-map  
-node接口：https://github.com/xiaoxian521/CURD-TS/tree/backend  
-doc文档：https://github.com/xiaoxian521/CURD-TS/tree/doc  
+[![license](https://img.shields.io/github/license/xiaoxian521/vue-pure-admin.svg)](LICENSE)

-github地址：https://github.com/xiaoxian521/CURD-TS  
-gitee地址：https://gitee.com/yiming_chang/CURD-TS  

-## 知识库地址
+**English** | [中文](./README.zh-CN.md)

-帮助你获取最新的 API  
-[vue3.0 中文文档地址]: https://vue3js.cn/docs/zh/  
-[element-plus 中文文档地址]: https://element-plus.org/#/zh-CN  
-[composition-Api 中文文档地址]: https://composition-api.vuejs.org/zh/  
-[vue-router-next 文档地址]: https://next.router.vuejs.org/  
-[next.vuex 文档地址]: https://next.vuex.vuejs.org/  
-[vite 源码]: https://github.com/vitejs/vite  
-[vite 文档地址]: https://vitejs.dev/  
-[vite 中文文档地址（非官方版本）]: https://vite-design.surge.sh/guide/chinese-doc.html  
-[vue-i18n-next]: https://vue-i18n-next.intlify.dev/  
-[composition-api-vue-i18n-next]: https://vue-i18n-next.intlify.dev/advanced/composition.html#local-scope  
+## Introduction

-## 安装依赖
+vue-pure-admin is a free and open source middle and back-end template. Using the latest `vue3`, `vite2`, `TypeScript`, `Element-Plus` and other mainstream technology development, the out-of-the-box middle and back-end front-end solutions can also be used for learning reference.

+## Preview
+
+- [vue-pure-admin](http://yiming_chang.gitee.io/manages) 
+
+Click to log in without password
+
+<p align="center">
+    <img alt="VbenAdmin Logo" width="100%" src="https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/31d4e268a9554389abb2b691a165f983~tplv-k3u1fbpfcp-watermark.image">
+    <img alt="VbenAdmin Logo" width="100%" src="https://p6-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/9c81c5348fb2476097dd847e3b050168~tplv-k3u1fbpfcp-watermark.image">
+    <img alt="VbenAdmin Logo" width="100%" src="https://p1-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/13749b799727449cbdcb2383f6ea1eb4~tplv-k3u1fbpfcp-watermark.image">
+    <img alt="VbenAdmin Logo" width="100%" src="https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/6745a79321cc40aba4de02aaf11ba4f2~tplv-k3u1fbpfcp-watermark.image">
+</p>
+
+### Use Gitpod
+
+Open the project in Gitpod (free online dev environment for GitHub) and start coding immediately.
+
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/xiaoxian521/vue-pure-admin)
+
+## Install and use
+
+- Get the project code
+
+```bash
+git clone https://github.com/xiaoxian521/vue-pure-admin.git
+or
+git clone https://github.com.cnpmjs.org/xiaoxian521/vue-pure-admin.git
 ```
+
+- Installation dependencies
+
+```bash
+cd vue-pure-admin
+
 npm install
-```
-
-## 项目运行

 ```
-npm run serve
+
+- run
+
+```bash
+yarn serve
 ```

-## 项目打包
+- build

-```
+```bash
 npm run build
 ```

-## 注意点
+## Change Log

-请先全局安装 typescript、ts-node、vite 如安装请忽略
+[CHANGELOG](./CHANGELOG.en_US.md)

-```
-npm install -g typescript
-npm install -g ts-node
-npm install -g create-vite-app
-```
+## How to contribute

-坑位  
-1.  
-path模块线上部署会遇到process is undefined问题  
-解决办法：在源码中开头加入window.process = {}  
-issues：https://github.com/jinder/path/issues/7  
-2.  
-运行项目时控制台报NODE_ENV not found  
-解决办法：删除node_modules和package-lock.json文件，重新npm install  
-3.  
-运行项目会感觉菜单切换比较卡，这个原因是使用route造成的，watch(route)是隐式的{ deep: true }，最好使用watchEffect  
-issues：https://github.com/vuejs/vue-next/issues/2027  
+You are very welcome to join！[Raise an issue](https://github.com/anncwb/vue-vben-admin/issues/new/choose) Or submit a Pull Request 
+
+**Pull Request:**
+
+1. Fork code!
+2. Create your own branch: `git checkout -b feat/xxxx`
+3. Submit your changes: `git commit -am 'feat(function): add xxxxx'`
+4. Push your branch: `git push origin feat/xxxx`
+5. submit`pull request`
+
+## Git Contribution submission specification
+
+- reference [vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) specification ([Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular))
+
+  - `feat` Add new features
+  - `fix` Fix the problem/BUG
+  - `style` The code style is related and does not affect the running result
+  - `perf` Optimization/performance improvement
+  - `refactor` Refactor
+  - `revert` Undo edit
+  - `test` Test related
+  - `docs` Documentation/notes
+  - `chore` Dependency update/scaffolding configuration modification etc.
+  - `workflow` Workflow improvements
+  - `ci` Continuous integration
+  - `types` Type definition file changes
+  - `wip` In development
+
+## Browser support
+
+The `Chrome 80+` browser is recommended for local development
+
+Support modern browsers, not IE
+
+| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari |
+| :-: | :-: | :-: | :-: | :-: |
+| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
+
+## Maintainer
+
+[xiaoxian521](https://github.com/xiaoxian521)
+
+## Donate
+
+If you think this project is helpful to you, you can help the author buy a cup of coffee to show your support!
+
+![donate](http://yiming_chang.gitee.io/manages/pay.jpg)
+
+## License
+
+[MIT © xiaoxian521-2020](./LICENSE)