diff --git a/README.md b/README.md index b557366e..ed77ad41 100755 --- a/README.md +++ b/README.md @@ -4,107 +4,170 @@ Solution of management system front-end based on `vue.js` and `ElementUI` -

- - vue - - - element-ui - - - vuex - - - axios - -

+# 介绍 -Welcome everyone to maintain +D2Admin 是一个开源的管理系统前端集成方案 -[Documentation (English)](https://fairyever.github.io/d2-admin/) / [中文文档](https://fairyever.github.io/d2-admin/zh/) +[Github仓库](https://github.com/FairyEver/d2-admin) - [预览地址](http://d2admin.fairyever.com/) -[Online preview / 在线预览](http://d2admin.fairyever.com/) +
+ + +
-**Do not clone this repository, please download the officially released version.** +::: tip +因为现在集成了很多的插件和组件,首次加载会占用很多的时间,虽然已经做了首屏加载动画,但还是建议您在发布之前一定要删除没有用到的代码,比如项目没有用到图表、示例、插件组件。 +::: -不要克隆这个仓库,请下载已经正式发行的版本 [Download / 下载](https://github.com/FairyEver/d2-admin/releases) +D2Admin 是完全开源免费的管理系统集成方案,由 [FairyEver](https://github.com/FairyEver) 在工作之余完全由兴趣驱动完成,如果你也一样喜欢前端开发,欢迎加入我们的讨论/学习群,群内可以`提问答疑`,`分享学习资料`或者随便扯淡 -**Do not clone this repository, please download the officially released version.** +**QQ群号 806395827 | 微信 liyang1711467488** -不要克隆这个仓库,请下载已经正式发行的版本 [Download / 下载](https://github.com/FairyEver/d2-admin/releases) +::: tip Thanks +D2Admin 创建于2018年1月14日零点51分,在2018年5月26日正式发布,中间断断续续做了四个多月,发布一个月内收获将近 700star,在此对支持我的朋友表示感谢,D2Admin 将会保持更新,如果你有想法、建议、或者问题欢迎加群讨论 -**Do not clone this repository, please download the officially released version.** +—— 2018年6月20日 +::: -不要克隆这个仓库,请下载已经正式发行的版本 [Download / 下载](https://github.com/FairyEver/d2-admin/releases) +## 功能 -> This project is suitable for use as a template. Because a lot of plug-ins and components are integrated now, the first load will take more time. Although the first screen loading animation has been done, it is suggested that you must delete the code that is not used when you release it. For example, the project does not use charts, so it is better to delete the integrated chart library and encapsulated chart components. +* 首屏加载等待动画 避免首次加载白屏尴尬 +* 简约主题 +* 每个插件和组件都配有介绍文档 +* 图片资源 sketch 源文件( 可以在这个文件内重新生成所有图片资源 ) +* 登陆和注销 +* 根据路由自动生成菜单 +* 可折叠侧边栏 +* 方便的菜单设置 +* 多国语言支持 +* 富文本编辑器 +* Markdown 编辑器 +* 全屏功能 +* Fontawesome 图标库 +* 图标选择器(组件) +* 自动引入下载的 SVG 图标 +* 前端假数据支持( mock ) +* 集成蚂蚁金服出品的 G2 图表 +* 图表自适应可拖拽大小的卡片容器(示例) +* 简化剪贴板操作 +* 简化Cookie操作 +* 时间日期计算工具 +* 导入 Excel ( xlsx 格式 + csv 格式 ) +* 数据导出 Excel ( xlsx 格式 + csv 格式 ) +* 数据导出文本 +* 数字动画 +* 可拖拽调整大小的切分布局 +* 可拖拽调整大小和位置的网格布局 +* 提供三种方便的页面容器组件(正常卡片,隐形容器,填满页面) +* 代码高亮显示 +* 加载并解析(或者直接指定资源) markdown 文件 +* GitHub 样式的 markdown 显示组件 +* markdown 内代码高亮 +* 为 markdown 扩展了百度云链接解析和优化显示 +* 右键菜单组件 +* 自定义滚动条和滚动控制 +* 内置4种主题 +* 公用样式抽离,方便的主题定制 +* 支持百万级数据量的表格组件 -## feature +## TODO -* first screen loading wait for animation to avoid first loading white screen embarrassment. -* brief theme -* each plug-in and component is equipped with an introduction document -* image resource sketch source file (you can regenerate all image resources in this file). -* landing and cancellation -* automatically generate menus based on Routing -* folding side sidebar -* multilingual support -* rich text editor -* Markdown editor -* full screen function -* Fontawesome Icon Library -* Fontawesome icon selector (component) -* automatic introduction of the downloaded SVG Icon -* front-end false data support (mock) -* integrated G2 chart -* chart adaptable drag and drop size card container (example) -* simplify the clipboard operation -* simplifying the Cookie operation -* time computing tool -* import Excel (xlsx format + CSV format) -* data export Excel (xlsx format + CSV format) -* data export text -* Digital Animation -* can drag and drop the size of the cut layout -* can drag and drop the size and location of the grid layout -* provide three kinds of page container components (normal cards, invisible containers, fill pages). -* code highlighting -* load and parse the markdown file -* GitHub style markdown display component -* markdown code is high -* extension of Baidu cloud link resolution and Optimization for markdown. +D2Admin 仍然处于开发中,这里有一些计划: -## Use +* 分离出简化版本 +* 推出基于 [ice](https://alibaba.github.io/ice) 平台的版本 +* 增加右上角通知中心 +* 增加一些实例页面以提供业务页面布局建议 +* 更换图表库 +* 多 tab 页结构 +* 面包屑导航 +* 树型表格组件 +* `1.1.0 完成` 抽离项目里的文档,集中存放在文档站点 +* `1.1.0 完成` 对主界面进行一次完善,调整整体布局和颜色 +* `1.1.0 完成` 切换主题功能 -install +欢迎你为 D2Admin 的开发作出贡献(代码编写/文档翻译)。 + +## 目录结构 ``` +├─ build +├─ config +├─ docs // 文档 +├─ src +│ ├─ assets // 资源 +│ │ ├─ icons +│ │ ├─ image +│ │ ├─ library +│ │ └─ style +│ ├─ components // 组件 +│ │ ├─ charts +│ │ ├─ core +│ │ └─ demo +│ ├─ i18n // 多国语 +│ ├─ menu // 菜单 +│ ├─ mock // 模拟数据 +│ ├─ pages // 页面 +│ ├─ plugin // 插件 +│ ├─ router // 路由 +│ ├─ store // vuex +│ ├─ utils +│ ├─ App.vue +│ └─ main.js +├─ static // 静态资源 +├─ .babelrc +├─ .editorconfig +├─ .eslintignore +├─ .eslintrc.js +├─ .gitattributes +├─ .gitignore +├─ .postcssrc.js +├─ LICENSE +├─ README.md +├─ deploy.sh +├─ design.sketch // 设计文件 +├─ index.html +└─ package.json + +``` + +## 使用 + +首先下载模板 [d2-admin/releases](https://github.com/FairyEver/d2-admin/releases) + +::: tip +不要直接克隆本项目,请选择上面已经发行的版本,如果克隆仓库,你将会得到不完全的代码。尤其不要使用 dev 分支 +::: + +``` +// 安装依赖 npm i -``` -run - -``` +// 运行 npm run dev + +// 打包 +npm run build ``` -The following environment tests are available +> 如果上述步骤出现错误,建议您升级 node 版本 > 8,如果有其它疑问请参考[常见问题](/zh/guide/question.html) + +## 书写文档 + +这里目前还有一个小遗憾,d2admin 使用的 webpack 版本不能符合 vuepress 的要求,所以如果你想在本地启动文档站点的服务,需要按下述步骤 + +首先将 vuepress 安装到全局 ``` -➜ ~ 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/ +npm i -g vuepress ``` -> Not recommended for use `cnpm` +启动服务 + +``` +npm run doc:dev +``` + +::: tip +你可能会发现项目目录中有一个 deploy.sh 文件,这个文件是为了方便发布文档用的,通常你并不需要使用它 +::: \ No newline at end of file diff --git a/docs/zh/guide/README.md b/docs/zh/guide/README.md index 9b8924c9..6bdd28c8 100644 --- a/docs/zh/guide/README.md +++ b/docs/zh/guide/README.md @@ -15,7 +15,7 @@ D2Admin 是一个开源的管理系统前端集成方案 D2Admin 是完全开源免费的管理系统集成方案,由 [FairyEver](https://github.com/FairyEver) 在工作之余完全由兴趣驱动完成,如果你也一样喜欢前端开发,欢迎加入我们的讨论/学习群,群内可以`提问答疑`,`分享学习资料`或者随便扯淡 - +**QQ群号 806395827 | 微信 liyang1711467488** ::: tip Thanks D2Admin 创建于2018年1月14日零点51分,在2018年5月26日正式发布,中间断断续续做了四个多月,发布一个月内收获将近 700star,在此对支持我的朋友表示感谢,D2Admin 将会保持更新,如果你有想法、建议、或者问题欢迎加群讨论