README_zh.md

QuanXiang

QuanXiang is a powerful, pluggable open source low-code platform.

---

English | 中文

官网 | 演示 | 文档 | 操作指南 | 论坛

QuanXiang 是什么

QuanXiang 是一个基于云原生、完全容器化的开源低代码平台，用于辅助构建企业各类数字化应用。平台目前提供云上无代码和低代码两种应用开发模式，支持可视化设计，让开发人员和业务用户能够通过简单的拖拽、参数配置等方式快速完成应用开发。作为一个集低代码开发能力、身份认证能力、容器 DevOps 能力于一体的多应用集成和管理平台，QuanXiang 支持快速构建应用、便捷维护管理应用、企业存量业务及全象云构建业务的集成。

平台功能

QuanXiang 围绕应用设计、开发、部署、运维全生命周期管理，构建低代码生态，为企业的信息化数智化建设赋能。平台核心能力如下：

🚀 快速应用开发

可视化设计器：用户通过简单的拖拽、参数配置等方式就能完成页面设计、工作流编排、数据模型设计和角色权限的定义。

表单引擎：系统提供丰富的页面组件，能够满足页面呈现的自定义组件需求。

工作流引擎：包含灵活的触发方式和丰富的流程组件，支持多种触发方式，表单数据触发、时间触发、表单时间触发等。同时提供审批、填写等人为节点处理，同时支持数据新增、数据更新等自动流程节点处理。同时提供规则引擎的能力，满足复杂业务下的逻辑定义。

☁️ 多云部署和运维

QuanXiang 基于 Kubernetes 的容器化部署方案，CI/CD 持续交付部署，为应用的平滑部署、稳定运行保驾护航，大大降低了应用上线后迭代升级的风险和复杂度。

支持不同云厂商的部署及运维。

平台提供系统日志，支持查看所有操作记录。

🤖 多端兼容适配

平台应用均可一次设计，在多端灵活适配。目前支持一键发布为 WEB 应用、Native APP、微信小程序。

🧑‍💻 灵活组织管理

企业通讯录：提供多种管理通讯录方式，帮助企业快速完成组织的构建。

角色管理：企业角色权限按需细分，保障平台账户访问安全和数据安全。

🗂 系统连接能力

平台内部支持跨应用间的数据连接，提供了不同粒度的数据连接能力，包括：表与表之间的数据联动更新、字段与字段间的联动交互。

平台支持不同粒度的方案集成，包括组件集成、页面集成、应用集成。

🧩 可插拔的架构

QuanXiang 是云原生、分布式架构的平台系统。各个核心服务（聚合类服务除外）采用完全解耦的、低内聚的方式设计，服务之间通过 API 接口进行访问。

设计界面

🔧施工中

架构说明

全象云低代码平台将前端与后端分离，提供即插即用（plug-and-play）、微服务的架构，并且支持不同的开发语言、开发框架。平台分为：应用层，对接层，数据处理层及基础层。

快速安装

全象云低代码平台提供了一套快速安装程序，使用者只需一条指令即可安装全象云低代码平台，目前支持 在 KubeSphere 环境中安装。

✨在 Kubesphere 环境中安装（推荐使用）

前提条件

• 已安装好 Kubernetes 环境。

第 1 步：安装 KubeSphere

安装 KubeSphere 有两种方式：

• 直接安装 KubeSphere，详细步骤参见 官方文档。
• 安装 KubeSphere(R)（QKE） （推荐），可以一键部署高可用的 KubeSphere 集群，并支持集群自动巡检和修复。

KubeSphere 部署环境的要求如下：

节点类型	节点数量	资源要求
master	1	CPU：4 核， 内存：8GB， 硬盘：80GB
worker 节点	5	CPU：4 核， 内存：8GB， 硬盘：80GB

注意

如果集群将用于生产或者准生产的话，建议将 worker 节点的内存和硬盘至少提高 1 倍，中间件部分推荐使用云厂商提供的 PaaS 或者服务。

第 2 步：安装全象云低代码平台

前提条件

安装全象云低代码平台前，您首先需要确保满足以下条件，然后再从我们的 release 中可以选择您需要的版本。

• 运行安装程序的系统可以访问 KubeSphere 集群。
• 已正确安装 kubectl，如果没有请先 安装 kubectl。
• 已正确配置 kubeconfig，若没配置请先完成配置。
  • QKE kubeconfig 可通过 QingCloud 控制台获取；
  • KubeSphere kubeconfig 请参见 官方文档 或者 求助社区 完成配置。
• 已安装 helm3，安装过程请参见 官方文档。

使用发行版

如果不希望自己编译的话可以直接使用我们发行版，点击 下载地址。注意区别不同版本的系统架构。

使用源码编译

需要先 git clone 项目源代码进行编译。需要注意的是修改指令中的 GOOS 和 GOARCH 以匹配系统架构，以 Linux amd64 为例：

 git clone https://github.com/quanxiang-cloud/quanxiang.git
 cd quanxiang
 git checkout master
 CGO_ENABLED=0 GOOS=linux GOARCH=adm64 go build -o installApp main.go

说明

• GOOS 可用系统：darwin、Linux、windows、freebsd 等;
• GOARCH 可用架构：amd64、386、arm 等。

开始安装

全象云低代码平台支持生产部署和试用部署：

• 生产环境可以先部署好中间件，具体内容可以参考 修改配置文件。
• 试用部署可以选择全部容器部署。

修改配置文件

如果您已经部署好中间件服务，并打算将其用于全象低代码平台安装，可以在配置文件 configs/configs.yml 中将对应的中间件中 enabled: true 改为 false。具体配置请参照下文内注释。

  vim configs/configs.yml
    #Middleware Services 中间件服务
    mysql:
      enabled: true
      rootPassword: qxp1234     #It is required to set the root user password if enabled equal to true    设置root用户密码 enabled为true时必填
    redis:
      enabled: true
      password: cXhwMTIzNA==    #The password here is the base64 code of the password. For example, the base64 code of qxp1234 is cxhwmjm0cg==  这里的password为密码的base64编码，比如qxp1234的base64编码为cXhwMjM0Cg==
    kafka:
              .....

安装

通过执行 installApp 指令来安装全象云低代码平台，试用版执行如下指令安装：

./installApp start -k ~/.kube/config -i -n lowcode

参数说明：

参数	作用	使用说明
-c/--configfile	配置文件路径	当前项目 configs/configs.yml 的绝对或者相对路径。
-d/--deploymentFile	部署文件夹的路径	当前项目 deployment 文件夹的绝对或相对路径。
-k/--kubeconfig	访问 k8s 集群的配置文件路径	如果该文件在默认位置 ～/.kube/config 可以不指定该参数。
-i/--middlerwareInit	中间件是否需要初始化	如果指定则对中间件进行初始化。
-n/--namespace	服务部署于 k8s 集群的命名空间	如果不指定默认为 default。

卸载

通过执行 installApp 指令进行卸载操作：

./installApp uninstall -n lowcode

参数的详细解释如下：

参数	作用	使用说明
-d/--deploymentFile	部署文件夹的路径	当前项目 deployment 文件夹的绝对或相对路径。
-k/--kubeconfig	访问 k8s 集群的配置文件路径	如果该文件在默认位置 ～/.kube/config 可以不指定该参数。
-n/--namespace	卸载的服务部署于 k8s 集群的命名空间	如果不指定默认为 default。
-u/--uninstallMiddlerware	是否需要卸载工具部署的中间件	若没有使用工具部署的中间件可以不引用此参数。若使用，卸载时报错没有此资源，忽略即可。

访问环境

配置网关

参考 KubeSphere 的官方文档。我们推荐使用 LoadBalancer 方式配置网关。

配置访问

访问 QuanxiangCloud 控制台，需要使用域名进行访问，可以配置 dns 或者指定本地 hosts 的方式进行访问。默认的用户名和密码是[email protected]/654321a..

• 通过 http://portal.qxp.com 访问 QuanxiangCloud 的管理端控制台。
• 通过 http://home.qxp.com 访问 QuanxiangCloud 的用户端。

注意

如果需要修改访问域名，可参见 kubesphere 的官方文档。

💸在原生 KuberNetes 环境上安装

敬请期待。

快速开始

请参考官方文档快速入门。

全象开源组件及功能列表

组件名称	组件功能	组件链接
app-center	应用管理中心：应用基本信息及应用权限管理	https://github.com/quanxiang-cloud/appcenter
audit	无
dispatcher	时间调度服务： 定时回掉指定任务接口
entrepot	任务管理中心：异步任务管理中心	https://github.com/quanxiang-cloud/entrepot
fileserver	文件服务：支持 aws s3 协议的对象存储上传与下载	https://github.com/quanxiang-cloud/fileserver
flow	低代码流程引擎：低代码流程定义、低代码业务节点扩展和低代码其它业务整合	https://github.com/quanxiang-cloud/flow
form	表单引擎：表单高级组件、以及 schema 的处理，与 structor 配合使用	https://github.com/quanxiang-cloud/form
goalie	权限管理：角色权限管理，RBAC 权限模型
kms	密钥管理：平台密钥管理及签名验证，外部密钥代理及鉴权	https://github.com/quanxiang-cloud/kms
message	消息服务：消息内容管理，邮件、站内信分发	https://github.com/quanxiang-cloud/message
nurturing	已废弃
organizations	组织服务：人员部门等信息管理，内置人员扩展字段服务功能	https://github.com/quanxiang-cloud/organizations
persona	应用配置中心：应用个性化配置数据存储	https://github.com/quanxiang-cloud/persona
polyapi	API 管理：API 注册，API 文档管理，第三方 API 代理，API 编排，API 统一调用	https://github.com/quanxiang-cloud/polyapi
polygate	API 网关：token/signature 认证，透明代理	https://github.com/quanxiang-cloud/polygate
process	流程引擎内核：流程模型定义、流程调度和实例数据记录	https://github.com/quanxiang-cloud/process
qxp-web-home	web 用户端服务	https://github.com/quanxiang-cloud/qxp-web
qxp-web-nginx	web 静态文件，后面要废弃
qxp-web-portal	web 管理端服务
structor	元数据管理：CURD 数据抽象，对接数据库管理	https://github.com/quanxiang-cloud/structor
transaction	已废弃
warden	认证服务：jwt 协议认证，生产管理 accesstoken，refreshtoken，支持第三方 jwt 协议 sso；

除此之外，还有我们的博客版块，该部分内容全部是全象开发团队写作分享的一些技术干货，原计划在官网下一版本更新中增加，大家有兴趣可以点击 Blog 进行查看，也可以访问我们的公众号/知乎号（全象云低代码）查看历史内容。

交流互动

• 💬 公众号：全象云低代码
• 🤖 Slack Channel：如果希望认识更多开发者与使用者，可以加入 QuanXiang Slack 群。
• 🙌 交流论坛：如果在使用过程中遇到了问题，或发现了 bug，可以在 QuanXiang 的讨论版块中反馈。或者提 issue 也可。