Skip to content

Commit 513c338

Browse files
committed
docs: update guide
1 parent 1940381 commit 513c338

File tree

2 files changed

+119
-15
lines changed

2 files changed

+119
-15
lines changed

README.md

Lines changed: 38 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,38 @@
11
# Vue Admin Next
22

3-
Professional enterprise application with **Multi-Module Design**, **Vue Composition API** and **Friendly User Interface**. Now is ready for production environment.
3+
Professional enterprise application with **Vue Composition API**, **Multi-Module Design**, **Data Processing Flow**, and **Friendly User Interface**. Now is ready for production environment.
4+
5+
> **Note**: When the official version of Vue 3.0 is released, this project will be migrated as soon as possible!
46
57
![GitHub](https://img.shields.io/github/license/openfext/vue-admin-next?style=flat-square)
68
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/openfext/vue-admin-next)
79

10+
:us: English | [:cn: 简体中文](README.zh-CN.md)
11+
12+
## Features
13+
14+
- ✨Vue Composition API
15+
- ✨Multi-Module Design
16+
- ✨Data Processing Flow
17+
- ✨Friendly User Interface
18+
- ✨Best Practices
19+
20+
## Example
21+
22+
[Vud Admin Next Preview](https://openfext.github.io/vue-admin-next/#/table/basic/query)
23+
24+
![Screen Capture](.github/preview.png)
25+
26+
## Quick Start
27+
28+
### From Template
29+
30+
[⚡ Generate Vue Admin Next](https://github.com/openfext/vue-admin-next/generate)
31+
32+
### Fork
33+
34+
[⚡ Fork Repository](https://github.com/openfext/vue-admin-next/fork)
35+
836
## Docs
937

1038
### 🇨🇳 Chinese
@@ -17,26 +45,21 @@ Professional enterprise application with **Multi-Module Design**, **Vue Composit
1745

1846
WIP...
1947

20-
## Example
48+
## Contacts
2149

22-
[Vud Admin Next Preview](https://openfext.github.io/vue-admin-next/#/table/basic/query)
50+
Welcome to join the group chat to discuss project issues and front-end technologies 💬
2351

24-
![Screen Capture](.github/preview.png)
52+
### QQ
2553

26-
## Quick Start
54+
ChatID: 667576147
2755

28-
```bash
29-
git clone https://github.com/openfext/vue-admin-next.git
30-
npm install
31-
npm run serve
32-
```
56+
![QQGroupQRCode](https://user-images.githubusercontent.com/2902215/84306575-3e785280-ab8e-11ea-8c53-af8620b5cc69.JPG)
3357

34-
## Features
58+
### WeChat Group
3559

36-
- ✨Vue Composition API
37-
- ✨Multi-Module Design
38-
- ✨Friendly User Interface
39-
- ✨Best Practices
60+
Add the author's WeChat to get into the group:
61+
62+
![WeChatQRCode](https://user-images.githubusercontent.com/2902215/84306570-3c15f880-ab8e-11ea-9041-8ea4ccbaa772.JPG)
4063

4164
## Built With
4265

README.zh-CN.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# Vue Admin Next
2+
3+
Vue Admin Next 是一套针对中后台应用场景的企业级 Web 应用脚手架,包含 **Vue Composition API****多模块设计****数据处理流****简洁的用户界面**等。你想要的都在这里,还等什么呢?
4+
5+
**提示**:当 Vue 3.0 正式版发布后,该项目会第一时间进行支持!
6+
7+
![GitHub](https://img.shields.io/github/license/openfext/vue-admin-next?style=flat-square)
8+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/openfext/vue-admin-next)
9+
10+
:cn: 简体中文 | [:us: English](README.md)
11+
12+
## 主要特性
13+
14+
- ✨Vue Composition API 实战
15+
- ✨ 多模块设计,结构划分清晰
16+
- ✨ 数据处理流,轻松处理复杂业务
17+
- ✨ 简洁的用户界面
18+
- ✨ 中后台应用开发的最佳实践
19+
20+
## 在线示例
21+
22+
[Vud Admin Next Preview](https://openfext.github.io/vue-admin-next/#/table/basic/query)
23+
24+
![Screen Capture](.github/preview.png)
25+
26+
## 快速开始
27+
28+
### 模板
29+
30+
[⚡ 生成 Vue Admin Next 项目](https://github.com/openfext/vue-admin-next/generate)
31+
32+
### Fork
33+
34+
[⚡ Fork 仓库](https://github.com/openfext/vue-admin-next/fork)
35+
36+
## 指南
37+
38+
- [自定义布局](https://openfext.github.io/docs/vue-admin-next/guide/layout.html)
39+
- [个性化主题](https://openfext.github.io/docs/vue-admin-next/guide/theme.html)
40+
- [导航配置](https://openfext.github.io/docs/vue-admin-next/guide/navigation.html)
41+
- [路由配置](https://openfext.github.io/docs/vue-admin-next/guide/router.html)
42+
- [文件组织](https://openfext.github.io/docs/vue-admin-next/guide/module-files.html)
43+
- [插件注册](https://openfext.github.io/docs/vue-admin-next/guide/plugin.html)
44+
- [数据处理](https://openfext.github.io/docs/vue-admin-next/guide/dataflow.html)
45+
- [用户权限](https://openfext.github.io/docs/vue-admin-next/guide/user.html)
46+
- [列表指南](https://openfext.github.io/docs/vue-admin-next/guide/table.html)
47+
- [表单指南](https://openfext.github.io/docs/vue-admin-next/guide/form.html)
48+
49+
## 参考文档
50+
51+
- [介绍](https://openfext.github.io/docs/vue-admin-next/intro.html)
52+
- [指南](https://openfext.github.io/docs/vue-admin-next/guide/start.html)
53+
- [API Reference](https://openfext.github.io/docs/vue-admin-next/api/component.html)
54+
55+
## 联系方式
56+
57+
欢迎加入群聊讨论项目问题和前端技术 💬
58+
59+
### QQ
60+
61+
群号:667576147
62+
63+
![QQGroupQRCode](https://user-images.githubusercontent.com/2902215/84306575-3e785280-ab8e-11ea-8c53-af8620b5cc69.JPG)
64+
65+
### 微信群
66+
67+
加作者微信进群:
68+
69+
![WeChatQRCode](https://user-images.githubusercontent.com/2902215/84306570-3c15f880-ab8e-11ea-9041-8ea4ccbaa772.JPG)
70+
71+
## 使用技术
72+
73+
- [Vue.js](https://github.com/vuejs/vue)
74+
- [Vue Use](https://github.com/openfext/vue-use)
75+
- [ElementUI](https://github.com/ElemeFE/element)
76+
77+
## License
78+
79+
[MIT](http://opensource.org/licenses/MIT)
80+
81+
Copyright (c) 2020 - present, Felix Yang

0 commit comments

Comments
 (0)