Files
mes-ui-d2/docs/zh/guide/README.md
liyang cfd60346b2 no message
Former-commit-id: 4bcb2c1f19f79da5603ea632dbcf4dd95599d2b9 [formerly 4bcb2c1f19f79da5603ea632dbcf4dd95599d2b9 [formerly 4bcb2c1f19f79da5603ea632dbcf4dd95599d2b9 [formerly 4bcb2c1f19f79da5603ea632dbcf4dd95599d2b9 [formerly 8efebded38f848fbac7860a20f1a41c69de784f2 [formerly 00dd7208e76fe1b3b6c08b91d90e4c407e88c1cd]]]]]
Former-commit-id: acc5c76e1d563c265a53d5f40d5505035056c0ed
Former-commit-id: d705fa7038f2cfaa9750007a0b594476efd5a25c
Former-commit-id: e4e16f928562a035ecc3db17cea08c4c5c86e95d [formerly 1fc7fee80041696c2d35dd0e98a74794343cf6fd]
Former-commit-id: 308a422f27d376b766e66688f5b811351dffd916
Former-commit-id: aadbd897dbfab8f34df3f3c3b1c84b1f92e7bbdf
Former-commit-id: f85346b2e4f559af449326d4bced6acb1a1fdb3b
Former-commit-id: f81e6f066849c9bf7648690748885fd0033fcc75
Former-commit-id: c0d380e9ee7d8b50d04c8ffd100445595efbcf7b
2018-06-20 14:46:16 +08:00

170 lines
5.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 介绍
D2Admin 是一个开源的管理系统前端集成方案
[Github仓库](https://github.com/FairyEver/d2-admin) - [预览地址](http://d2admin.fairyever.com/)
<div>
<iframe src="//ghbtns.com/github-btn.html?user=FairyEver&repo=d2-admin&type=star&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="100" height="20"></iframe>
<iframe src="//ghbtns.com/github-btn.html?user=FairyEver&repo=d2-admin&type=fork&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="100" height="20"></iframe>
</div>
::: tip
因为现在集成了很多的插件和组件,首次加载会占用很多的时间,虽然已经做了首屏加载动画,但还是建议您在发布之前一定要删除没有用到的代码,比如项目没有用到图表、示例、插件组件。
:::
## 小组
D2Admin 是完全开源免费的管理系统集成方案,由 [FairyEver](https://github.com/FairyEver) 在工作之余完全由兴趣驱动完成,如果你也一样喜欢前端开发,欢迎加入我们的讨论,群内可以`提问答疑``分享学习资料`或者随便扯淡
<img style="margin-top: 50px;" src="./image/qr.png">
## 功能
* 首屏加载等待动画 避免首次加载白屏尴尬
* 简约主题
* 每个插件和组件都配有介绍文档
* 图片资源 sketch 源文件( 可以在这个文件内重新生成所有图片资源
* 登陆和注销
* 根据路由自动生成菜单
* 可折叠侧边栏
* 方便的菜单设置
* 多国语言支持
* 富文本编辑器
* Markdown 编辑器
* 全屏功能
* [Fontawesome](https://fontawesome.com/) 图标库
* 图标选择器(组件)
* 自动引入下载的 SVG 图标
* 前端假数据支持( mock
* 集成 [G2](http://g2.alipay.com/) 图表
* 图表自适应可拖拽大小的卡片容器(示例)
* 简化剪贴板操作
* 简化Cookie操作
* 时间日期计算工具
* 导入 Excel xlsx 格式 + csv 格式
* 数据导出 Excel xlsx 格式 + csv 格式
* 数据导出文本
* 数字动画
* 可拖拽调整大小的切分布局
* 可拖拽调整大小和位置的网格布局
* 提供三种方便的页面容器组件(正常卡片,隐形容器,填满页面)
* 代码高亮显示
* 加载并解析(或者直接指定资源) markdown 文件
* GitHub 样式的 markdown 显示组件
* markdown 内代码高亮
* 为 markdown 扩展了百度云链接解析和优化显示
* 右键菜单组件
* 自定义滚动条和滚动控制
* 内置4种主题
* 公用样式抽离,方便的主题定制
* 支持百万级数据量的表格组件
## TODO
D2Admin 仍然处于开发中,这里有一些计划:
* `1.1.0 完成` 抽离项目里的文档,集中存放在文档站点
* `1.1.0 完成` 对主界面进行一次完善,调整整体布局和颜色
* `1.1.0 完成` 切换主题功能
* `1.1.0 完成` 使用自定义滚动条
* 分离出简化版本
* 推出基于 [ice](https://alibaba.github.io/ice) 平台的版本
* 增加右上角通知中心
* 增加一些实例页面以提供业务页面布局建议
* 更换图表库
* 树型表格组件
欢迎你为 D2Admin 的开发作出贡献(代码编写/文档翻译)。
## 目录结构
```
├─ build // 打包设置
├─ config // 发布设置
├─ preview-image // github 介绍页面使用的插图 以后可能去掉
├─ src
│ ├─ assets
│ │ ├─ icons // 存放 svg 图标
│ │ ├─ image // 图片
│ │ ├─ library // 库
│ │ └─ style // 公用样式
│ ├─ components
│ │ ├─ charts // 封装图表组件
│ │ ├─ core // 核心组件
│ │ ├─ demo // 只会在示例页面中使用的组件
│ ├─ i18n // 多国语言配置
│ ├─ mock // mock 数据设置
│ ├─ pages
│ │ ├─ core // 系统页面
│ │ └─ demo // 演示页面
│ │ ├─ business // 业务页面示例
│ │ ├─ chart // 图表
│ │ ├─ components // 组件
│ │ └─ plugins // 插件
│ ├─ plugin // 插件
│ ├─ router // 路由
│ │ ├─ invisible
│ │ └─ menu
│ ├─ store // 全局状态
│ ├─ utils // 通用工具
│ ├─ App.vue
│ └─ main.js // 入口文件
├─ static
├─ .babelrc
├─ .editorconfig
├─ .eslintignore
├─ .eslintrc.js
├─ .gitignore
├─ .postcssrc.js
├─ LICENSE
├─ README.md
├─ design.sketch
├─ index.html
├─ package-lock.json
└─ package.json
```
## 使用
首先下载模板 [d2-admin/releases](https://github.com/FairyEver/d2-admin/releases)
::: tip
不要直接克隆本项目,请选择上面已经发行的版本,如果克隆仓库,你将会得到不完全的代码。尤其不要使用 dev 分支
:::
安装依赖
```
npm i
```
运行
```
npm run dev
```
在以下环境测试可用
```
➜ ~ npm -v
5.6.0
➜ ~ node -v
v8.11.1
➜ ~ nrm -V
1.0.2
➜ ~ nrm ls
npm ---- https://registry.npmjs.org/
cnpm --- http://r.cnpmjs.org/
* taobao - https://registry.npm.taobao.org/
nj ----- https://registry.nodejitsu.com/
rednpm - http://registry.mirror.cqupt.edu.cn/
npmMirror https://skimdb.npmjs.com/registry/
edunpm - http://registry.enpmjs.org/
```
::: tip
推荐使用 [nrm](https://github.com/Pana/nrm) 管理 npm 源,不建议使用 cnpm
:::