Skip to content

Commit 8991926

Browse files
ArmourArmour
committed
Docs(readme): update README.md
1 parent b7881e2 commit 8991926

File tree

12 files changed

+337
-36
lines changed

12 files changed

+337
-36
lines changed

‎.github/main.workflow

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ workflow "Deploy on GitHub Pages" {
55

66
action "Filters for GitHub Actions" {
77
uses = "actions/bin/filter@master"
8-
args = "branch full-features"
8+
args = "branch master"
99
}
1010

1111
action "Yarn install" {

‎README-zh.md

+169-14
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,181 @@
1-
# vue-typescript-admin-template
2-
3-
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](http://makeapullrequest.com)
4-
[![CircleCI](https://circleci.com/gh/Armour/vue-typescript-admin-template/tree/master.svg?style=shield)](https://circleci.com/gh/Armour/vue-typescript-admin-template/tree/master)
5-
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
6-
[![Template from jarvis](https://img.shields.io/badge/Hi-Jarvis-ff69b4.svg)](https://github.com/Armour/Jarvis)
1+
<p align="center">
2+
<img width="120" src="public/img/icons/android-chrome-512x512.png">
3+
</p>
4+
5+
<p align="center">
6+
<a href="https://github.com/vuejs/vue">
7+
<img src="https://img.shields.io/badge/vue-2.6.10-brightgreen.svg" alt="vue">
8+
</a>
9+
<a href="https://github.com/ElemeFE/element">
10+
<img src="https://img.shields.io/badge/element--ui-2.8.2-brightgreen.svg" alt="element-ui">
11+
</a>
12+
<a href="https://circleci.com/gh/Armour/vue-typescript-admin-template/tree/master">
13+
<img src="https://circleci.com/gh/Armour/vue-typescript-admin-template/tree/master.svg?style=shield" alt="CircleCI">
14+
</a>
15+
<a href="http://makeapullrequest.com">
16+
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" alt="PRs Welcome">
17+
</a>
18+
<a href="https://opensource.org/licenses/MIT">
19+
<img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License: MIT">
20+
</a>
21+
<a href="https://github.com/Armour/Jarvis">
22+
<img src="https://img.shields.io/badge/Hi-Jarvis-ff69b4.svg" alt="Template from jarvis">
23+
</a>
24+
</p>
25+
26+
[English](./README.md) | 简体中文
727

828
## 总览
929

10-
**!!! 包涵完整功能组件的版本正在积极开发中！欢迎参与贡献👏！可以切换到 `full-features` 分支或进入线上地址查看详情 :)**
30+
[vue-typescript-admin-template](http://armour.github.io/vue-typescript-admin-template) 是一个后台前端解决方案，它基于 [vue](https://github.com/vuejs/vue), [typescript](https://www.typescriptlang.org/) 和 [element-ui](https://github.com/ElemeFE/element)实现。原始的 Javscript 版本的代码是由 [PanJiaChen](https://github.com/PanJiaChen) 开发维护的 [vue-element-admin](https://github.com/PanJiaChen/vue-element-admin/)， 十分感谢大佬对开源社区做出的贡献 :)
31+
32+
## 线上文档
1133

12-
这是一个极简的 vue typescript admin 管理后台。它只包含了 Element UI & axios & svgicon & permission control & lint，这些搭建后台必要的东西。部分源代码是由 [vue-cli](https://github.com/vuejs/vue-cli) 和 [jarvis](https://github.com/Armour/Jarvis) 自动生成的
34+
[文档](https://armour.github.io/vue-typescript-admin-docs)
1335

1436
## 线上地址
1537

16-
[Admin Panel](https://armour.github.io/vue-typescript-admin-template)
38+
[示例](https://armour.github.io/vue-typescript-admin-template)
1739

18-
## 截图/动图
40+
## 截图
1941

20-
![demo](./demo/demo.gif)
42+
![主页](./demo/dashboard.png))
2143

2244
## 相关项目
2345

46+
[Armour/vue-typescript-admin-mock-server](https://github.com/armour/vue-typescript-admin-mock-server) (mock server for this project)
47+
48+
[Armour/vue-typescript-admin-docs](https://github.com/armour/vue-typescript-admin-docs) (documentation source for this project)
49+
50+
Javascript 版本:
51+
2452
[PanJiaChen/vue-admin-template](https://github.com/PanJiaChen/vue-admin-template) (a vue2.0 minimal admin template)
2553

2654
[PanJiaChen/vue-element-admin](https://github.com/PanJiaChen/vue-element-admin) (full features supported vue admin)
2755

2856
[PanJiaChen/electron-vue-admin](https://github.com/PanJiaChen/electron-vue-admin) (a vue electron admin project)
2957

58+
## 功能
59+
60+
```txt
61+
- 登录 / 注销
62+
63+
- 权限验证
64+
- 页面权限
65+
- 指令权限
66+
- 权限配置
67+
- 二步登录
68+
69+
- 多环境发布
70+
- Dev / Stage / Prod
71+
72+
- 全局功能
73+
- 国际化多语言
74+
- 动态换肤
75+
- 动态侧边栏（支持多级路由嵌套）
76+
- 动态面包屑
77+
- 快捷导航(支持右键操作)
78+
- 粘贴板
79+
- Svg 图标
80+
- 搜索
81+
- 全屏
82+
- 设置
83+
- Mock 数据 / Mock 服务器
84+
- 支持 PWA
85+
86+
- 组件
87+
- 编辑器
88+
- 富文本编辑器
89+
- Markdown 编辑器
90+
- JSON 编辑器
91+
- 头像上传
92+
- 返回顶部
93+
- CountTo
94+
- 拖放区
95+
- 拖拽弹窗
96+
- 拖拽看板
97+
- 拖拽列表
98+
- 拖拽选择
99+
- ECharts 图表
100+
- Mixin
101+
- 拆分窗格
102+
- 黏性组件
103+
104+
- 表格
105+
- 动态表格
106+
- 拖拽表格
107+
- 内联编辑表格
108+
- 复杂表格
109+
110+
- Excel
111+
- 导出excel
112+
- 导入excel
113+
- 前端可视化excel
114+
115+
- Zip
116+
- 导出zip
117+
118+
- PDF
119+
- 下载 pdf
120+
121+
- 控制台
122+
- 引导页
123+
- 综合实例
124+
- 错误日志
125+
- 错误页面
126+
- 401
127+
- 404
128+
```
129+
130+
## 前序准备
131+
132+
你需要在本地安装 [node](http://nodejs.org/) 和 [git](https://git-scm.com/)。本项目技术栈基于 [typescript](https://www.typescriptlang.org/)、[vue](https://cn.vuejs.org/index.html)、[vuex](https://vuex.vuejs.org/zh-cn/)、[vue-router](https://router.vuejs.org/zh-cn/) 、[vue-cli](https://github.com/vuejs/vue-cli) 、[axios](https://github.com/axios/axios) 和 [element-ui](https://github.com/ElemeFE/element)，所有的请求数据都使用[faker.js](https://github.com/Marak/Faker.js)进行模拟，提前了解和学习这些知识会对使用本项目有很大的帮助。
133+
134+
## 目录结构
135+
136+
本项目已经为你生成了一个完整的开发框架，提供了涵盖后台开发的各类功能和坑位，下面是整个项目的目录结构。
137+
138+
```bash
139+
├── mock # mock 服务器 与 模拟数据
140+
├── public # 静态资源 (会被直接复制)
141+
│ │── favicon.ico # favicon图标
142+
│ │── manifest.json # PWA 配置文件
143+
│   └── index.html # html模板
144+
├── src # 源代码
145+
│   ├── api # 所有请求
146+
│   ├── assets # 主题 字体等静态资源 (由 webpack 处理加载)
147+
│   ├── components # 全局组件
148+
│   ├── directive # 全局指令
149+
│   ├── filters # 全局过滤函数
150+
│   ├── icons # svg 图标
151+
│   ├── lang # 国际化
152+
│   ├── layout # 全局布局
153+
│ ├── pwa # PWA service worker 相关的文件
154+
│   ├── router # 路由
155+
│   ├── store # 全局 vuex store
156+
│   ├── styles # 全局样式
157+
│   ├── utils # 全局方法
158+
│   ├── views # 所有页面
159+
│   ├── App.vue # 入口页面
160+
│   ├── main.js # 入口文件 加载组件 初始化等
161+
│ ├── permission.ts # 权限管理
162+
│ ├── settings.ts # 设置文件
163+
│ └── shims.d.ts # 模块注入
164+
├── tests # 测试
165+
├── .circleci/ # 自动化 CI 配置
166+
├── .browserslistrc # browserslistrc 配置文件 (用于支持 Autoprefixer)
167+
├── .editorconfig # 编辑相关配置
168+
├── .env.xxx # 环境变量配置
169+
├── .eslintrc.js # eslint 配置
170+
├── babel.config.js # babel-loader 配置
171+
├── cypress.json # e2e 测试配置
172+
├── jest.config.js # jest 单元测试配置
173+
├── package.json # package.json 依赖
174+
├── postcss.config.js # postcss 配置
175+
├── tsconfig.json # typescript 配置
176+
└── vue.config.js # vue-cli 配置
177+
```
178+
30179
## 如何设置以及启动项目
31180

32181
### 安装依赖
@@ -44,7 +193,7 @@ yarn serve
44193
### 构建生产环境 (自带压缩)
45194

46195
```bash
47-
yarn build
196+
yarn build:prod
48197
```
49198

50199
### 代码格式检查以及自动修复
@@ -65,9 +214,15 @@ yarn test:unit
65214
yarn test:e2e
66215
```
67216

217+
### 自动生成 svg 组件
218+
219+
```bash
220+
yarn run svg
221+
```
222+
68223
### 自定义 Vue 配置
69224

70-
See [Configuration Reference](https://cli.vuejs.org/config/).
225+
请看 [Configuration Reference](https://cli.vuejs.org/config/).
71226

72227
## 浏览器支持
73228

@@ -79,7 +234,7 @@ Modern browsers and Internet Explorer 10+.
79234

80235
## 参与贡献
81236

82-
See [CONTRIBUTING.md](https://github.com/Armour/vue-typescript-admin-template/blob/master/.github/CONTRIBUTING.md)
237+
请看 [CONTRIBUTING.md](https://github.com/Armour/vue-typescript-admin-template/blob/master/.github/CONTRIBUTING.md)
83238

84239
## License
85240

0 commit comments

Comments
 (0)