docs: update docs

This commit is contained in:
xiaoxian521 2021-04-13 18:37:47 +08:00
parent 0d1f5bb673
commit 8a8068bbab
7 changed files with 238 additions and 48 deletions

6
.gitpod.yml Normal file
View File

@ -0,0 +1,6 @@
ports:
- port: 3344
onOpen: open-preview
tasks:
- init: npm
command: npm serve

5
CHANGELOG.en_US.md Normal file
View File

@ -0,0 +1,5 @@
# 2.0.0(2021-4-13)
### 🎫 Chores
- Release 2.0.0 version

5
CHANGELOG.md Normal file
View File

@ -0,0 +1,5 @@
# 2.0.0(2021-4-13)
### 🎫 Chores
- Release 2.0.0 version

5
CHANGELOG.zh_CN.md Normal file
View File

@ -0,0 +1,5 @@
# 2.0.0(2021-4-13)
### 🎫 Chores
- 发布2.0.0版本

147
README.md
View File

@ -1,67 +1,118 @@
# Vue3.0后台管理系统 <h1>vue-pure-admin</h1>
### 功能已开发完毕兼容移动端新需求请提issues
vue版本代码https://github.com/xiaoxian521/CURD-TS [![license](https://img.shields.io/github/license/xiaoxian521/vue-pure-admin.svg)](LICENSE)
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
github地址https://github.com/xiaoxian521/CURD-TS
gitee地址https://gitee.com/yiming_chang/CURD-TS
## 知识库地址 **English** | [中文](./README.zh-CN.md)
帮助你获取最新的 API ## Introduction
[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
## 安装依赖 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 install
```
## 项目运行
``` ```
npm run serve
- run
```bash
yarn serve
``` ```
## 项目打包 - build
``` ```bash
npm run build npm run build
``` ```
## 注意点 ## Change Log
请先全局安装 typescript、ts-node、vite 如安装请忽略 [CHANGELOG](./CHANGELOG.en_US.md)
``` ## How to contribute
npm install -g typescript
npm install -g ts-node
npm install -g create-vite-app
```
坑位 You are very welcome to join[Raise an issue](https://github.com/anncwb/vue-vben-admin/issues/new/choose) Or submit a Pull Request
1.
path模块线上部署会遇到process is undefined问题 **Pull Request:**
解决办法在源码中开头加入window.process = {}
issueshttps://github.com/jinder/path/issues/7 1. Fork code!
2. 2. Create your own branch: `git checkout -b feat/xxxx`
运行项目时控制台报NODE_ENV not found 3. Submit your changes: `git commit -am 'feat(function): add xxxxx'`
解决办法删除node_modules和package-lock.json文件重新npm install 4. Push your branch: `git push origin feat/xxxx`
3. 5. submit`pull request`
运行项目会感觉菜单切换比较卡这个原因是使用route造成的watch(route)是隐式的{ deep: true }最好使用watchEffect
issueshttps://github.com/vuejs/vue-next/issues/2027 ## 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)

118
README.zh-CN.md Normal file
View File

@ -0,0 +1,118 @@
<h1>vue-pure-admin</h1>
[![license](https://img.shields.io/github/license/xiaoxian521/vue-pure-admin.svg)](LICENSE)
**中文** | [English](./README.md)
## 简介
vue-pure-admin 是一个免费开源的中后台模版。使用了最新的`vue3`,`vite2`,`TypeScript`,`Element-Plus`等主流技术开发,开箱即用的中后台前端解决方案,也可用于学习参考。
## 预览
- [vue-pure-admin](http://yiming_chang.gitee.io/manages)
点击免密登录
<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>
### 使用 Gitpod
在 Gitpod适用于 GitHub 的免费在线开发环境)中打开项目,并立即开始编码.
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/xiaoxian521/vue-pure-admin)
## 安装使用
- 获取项目代码
```bash
git clone https://github.com/xiaoxian521/vue-pure-admin.git
or
git clone https://github.com.cnpmjs.org/xiaoxian521/vue-pure-admin.git
```
- 安装依赖
```bash
cd vue-pure-admin
npm install
```
- 运行
```bash
yarn serve
```
- 打包
```bash
npm run build
```
## 更新日志
[CHANGELOG](./CHANGELOG.zh_CN.md)
## 如何贡献
非常欢迎你的加入![提一个 Issue](https://github.com/anncwb/vue-vben-admin/issues/new/choose) 或者提交一个 Pull Request
**Pull Request:**
1. Fork 代码!
2. 创建自己的分支: `git checkout -b feat/xxxx`
3. 提交你的修改: `git commit -am 'feat(function): add xxxxx'`
4. 推送您的分支: `git push origin feat/xxxx`
5. 提交`pull request`
## Git 贡献提交规范
- 参考 [vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) 规范 ([Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular))
- `feat` 增加新功能
- `fix` 修复问题/BUG
- `style` 代码风格相关无影响运行结果的
- `perf` 优化/性能提升
- `refactor` 重构
- `revert` 撤销修改
- `test` 测试相关
- `docs` 文档/注释
- `chore` 依赖更新/脚手架配置修改等
- `workflow` 工作流改进
- `ci` 持续集成
- `types` 类型定义文件更改
- `wip` 开发中
## 浏览器支持
本地开发推荐使用`Chrome 80+` 浏览器
支持现代浏览器, 不支持 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 |
## 维护者
[xiaoxian521](https://github.com/xiaoxian521)
## 捐赠
如果你觉得这个项目对你有帮助,你可以帮作者买一杯咖啡表示支持!
![donate](http://yiming_chang.gitee.io/manages/pay.jpg)
## License
[MIT © xiaoxian521-2020](./LICENSE)

BIN
public/pay.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 91 KiB