Git Product home page Git Product logo

vertx-ui's Introduction

Zero UI帮助文档

天行有常,不为尧存,不为桀亡。——《荀子·天论》

0. 引导

1. 介绍

1.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中提供的组件。
  • 使用JSDoc生成UxEx的专用API文档。
  • 可启用DnD拖拽实现企业交互

文档参考:《云端白皮书》 目前版本支持的模块:

1.2. 在线文档

  • 文档首页(该链接为应用首页,每个应用都可以打开,内置链接可直接进入到 UxEx 部分)

  • Ux文档,ZeroUI核心框架

    import Ux from 'ux';
    Ux.xxx          // 直接调用Ux中的方法
  • Ex文档,ZeroUI扩展框架

    import Ex from 'ex';
    Ex.xxx          // 直接调用Ex中的方法

2. 开始

2.1. 工程初始化

参考:https://gitee.com/silentbalanceyh/scaffold-ui

2.2. 文档本地化

  1. 确认系统中安装了node, jsdoc, docdash, live-server, taffydb模块,其中 taffydb 有可能需要本地化安装,追加到您的开发依赖项中。

  2. 执行下边命令生成文档:

    ./run-doc.sh doc                      # 带 doc 参数
  3. 执行命令启动文档服务器,默认端口:30211

    ./run-doc.sh server                   # 启动文档服务器
  4. 根据执行引导查看文档。

vertx-ui's People

Contributors

silentbalanceyh avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.