Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/silentbalanceyh/vertx-ui
Zero UI前端框架：http://www.vertxui.cn
https://github.com/silentbalanceyh/vertx-ui
antd-design-pro antdesign react react-router-v4 redux rxjs-observable rxjs5
Last synced: 21 days ago
JSON representation
Zero UI前端框架：http://www.vertxui.cn
- Host: GitHub
- URL: https://github.com/silentbalanceyh/vertx-ui
- Owner: silentbalanceyh
- License: apache-2.0
- Created: 2017-12-11T22:41:17.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-06-02T20:39:18.000Z (over 1 year ago)
- Last Synced: 2023-06-02T21:27:42.663Z (over 1 year ago)
- Topics: antd-design-pro, antdesign, react, react-router-v4, redux, rxjs-observable, rxjs5
- Language: HTML
- Homepage:
- Size: 36.1 MB
- Stars: 31
- Watchers: 11
- Forks: 16
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Zero UI帮助文档
> _天行有常，不为尧存，不为桀亡。——《荀子·天论》_
## 0. 引导
- （后端）Zero Ecotope：
- （前端）Zero UI：
- （工具）Zero AI：
- （标准）Zero Schema：
## 1. 介绍
### 1.1. 基本介绍
Zero UI为[Vert.x Zero Up Framework](http://www.vertxup.cn)的前端脚手架，主要用于和Vert.x Zero
Up微服务框架后端进行配合开发，该前端脚手架主要内容如下：
* 使用React, Redux, Rxjs, React-Router和Ant-Design/Ant-Design-Pro为核心库基础
* 使用TypeScript开发视图层以下的模型，React采用ES2017+的注解语法实现无配置的界面开发
* 提供企业系统中常用组件，以及Utility X的包完成通用功能的提取，简化开发人员流程
* 采用Storybook模式通过教程方式告诉开发人员如何使用Zero UI中提供的组件。
* 使用JSDoc生成`Ux`和`Ex`的专用API文档。
* 可启用DnD拖拽实现企业交互
文档参考：[《云端白皮书》](https://www.vertx-cloud.cn/document/doc-web/index.html) 目前版本支持的模块：
### 1.2. 在线文档
* [文档首页](/document/doc-web/index.html)（该链接为应用首页，每个应用都可以打开，内置链接可直接进入到 `Ux` 和 `Ex` 部分）
* [Ux文档](/document/doc-web/zui/index.html)，ZeroUI核心框架
```js
import Ux from 'ux';
Ux.xxx // 直接调用Ux中的方法
```
* [Ex文档](/document/doc-web/zextension/index.html)，ZeroUI扩展框架
```js
import Ex from 'ex';
Ex.xxx // 直接调用Ex中的方法
```
## 2. 开始
### 2.1. 工程初始化
参考：
### 2.2. 文档本地化
1. 确认系统中安装了`node, jsdoc, docdash, live-server, taffydb`模块，其中 `taffydb` 有可能需要本地化安装，追加到您的开发依赖项中。
2. 执行下边命令生成文档：
```shell
./run-doc.sh doc # 带 doc 参数
```
3. 执行命令启动文档服务器，默认端口：`30211`：
```shell
./run-doc.sh server # 启动文档服务器
```
4. 根据执行引导查看文档。