0.1.0 • Published 6 years ago
vertx-zero v0.1.0
Zero UI帮助文档
如果说组件是没有生命的驱壳，数据则是灵魂，而我们想要创造的是拥有灵魂的“精灵”。
1. 介绍
Zero UI为Vert.x Zero Up Framework的前端脚手架，主要用于和Vert.x Zero Up微服务框架后端进行配合开发，该前端脚手架主要内容如下：
- 使用React, Redux, Rxjs, React-Router和Ant-Design/Ant-Design-Pro为核心库基础
- 使用TypeScript开发视图层以下的模型，React采用ES2017+的注解语法实现无配置的界面开发
- 提供企业系统中常用组件，以及Utility X的包完成通用功能的提取，简化开发人员流程
- 采用Storybook模式通过教程方式告诉开发人员如何使用Zero UI中提供的组件。
该项目中使用了两个项目作为参考Demo，一个项目为通用企业项目，另外一个项目则是Zero Up Framework的后端监控框架，统一采用Zero UI来完成，官方网址：
- Vert.x Zero Up Framework: http://www.vertxup.cn
- Zero UI Framework: http://www.vertxui.cn
依赖库固定版本（升级后有兼容性问题）
| 库名称 | 当前版本 | 最新版 |
|---|---|---|
| rxjs | 5.5.10 | 6.1.0 |
| webpack | 3.11.0 | 4.6.0 |
| webpack-dev-server | 3.0.0 | 3.1.4 |
| awesome-typescript-loader | 4.0.1 | 5.0.0 |
文档基本前缀说明。
UI文档为开发文档，提供给开发人员使用来开发项目专用；UT文档为研发文档，提供给研发人员开发Zero UI专用；
2. 整体架构
整个Zero框架的结构图如下：
3. 文档列表
环境说明
- UI0001 - 脚手架说明
- UI0002 - 环境变量
- UI0003 - 路由/资源文件说明
- UI0007 - 编码规范——文件命名
- UI0008 - 编码规范——代码约定
- UI0006 - 模板/组件规范示例
开发文档
步步为营
Ux工具包
参考UT0001，运行脚本run-doc.sh，则可以从浏览器查看文档：http://localhost:5000/
脚手架解析
0.1.0
6 years ago