lowcode-engine README

The project's README from github.com/alibaba/lowcode-engine. As one markdown file: README.md.

LowCodeEngine

An enterprise-class low-code technology stack with scale-out design

NPM version NPM downloads

Issues need help

codecov Awesome

English | 简体中文

✨ Features

🎯 Compatible Environments

📚 Engine Protocol

The engine fully implements the "LowCodeEngine Basic Construction Protocol Specification" and "LowCodeEngine Material Protocol Specification". The protocol stack is a key part of whether materials in the low-code field can be circulated.

image

🌰 Usage example

npm install @alilc/lowcode-engine --save-dev

TIPS: Only cdn import is supported, npm package is used to provide code hinting capabilities such as typings

import { init, skeleton } from '@alilc/lowcode-engine';

skeleton.add({
  area: 'topArea',
  type: 'Widget',
  name: 'logo',
  content: YourFantasticLogo,
  contentProps: {
    logo:
      'https://img.alicdn.com/tfs/TB1_SocGkT2gK0jSZFkXXcIQFXa-66-66.png',
    href: '/',
  },
  props: {
    align: 'left',
    width: 100,
  },
});

init(document.getElementById('lce'));

Engineering configuration:

{
  "externals": {
    "@alilc/lowcode-engine": "var window.AliLowCodeEngine",
    "@alilc/lowcode-engine-ext": "var window.AliLowCodeEngineExt"
  }
}

cdn optional method:

Method 1: alifd cdn

https://alifd.alicdn.com/npm/@alilc/[email protected]/dist/js/engine-core.js

https://alifd.alicdn.com/npm/@alilc/[email protected]/dist/js/react-simulator-renderer.js

Method 2: uipaas cdn

https://uipaas-assets.com/prod/npm/@alilc/lowcode-engine/1.0.18/dist/js/engine-core.js

https://uipaas-assets.com/prod/npm/@alilc/lowcode-react-simulator-renderer/1.0.18/dist/js/react-simulator-renderer.js

Method 3: unpkg

https://unpkg.com/@alilc/[email protected]/dist/js/engine-core.js

https://unpkg.com/@alilc/[email protected]/dist/js/react-simulator-renderer.js

Method 4: jsdelivr

https://cdn.jsdelivr.net/npm/@alilc/[email protected]/dist/js/engine-core.js

https://cdn.jsdelivr.net/npm/@alilc/[email protected]/dist/js/react-simulator-renderer.js

Method 5: Use your own cdn

Pass the files under packages/engine/dist and packages/react-simulator-renderer/dist in the source code to your cdn provider

This awesome-lowcode-engine page links to a repository which records all of the tools\materials\solutions that use or built for the lowcode-engine, PR is welcomed.

💻 Local debugging

$ git clone [email protected]:alibaba/lowcode-engine.git
$ cd lowcode-engine
$ npm install
$ npm run setup
$ npm start

📢 npm access speed is slow, Alibaba employees can use tnpm, other students recommend using cnpm or specifying a mirror registry.

📢 Windows environment must use WSL, other terminals are not guaranteed to work normally

After lowcode-engine is started, several umd files are provided, which can be debugged in combination with the lowcode-demo project. Refer to the file proxy rules here.

🤝 Participation

Please read first:

  1. How to configure the engine debugging environment?
  2. About the R&D collaboration process of the engine
  3. Engineering Configuration of Engine

Strongly recommend reading "The Wisdom of Asking Questions", ["How to Ask Questions to the Open Source Community"](https: //github.com/seajs/seajs/issues/545) and How to Report Bugs Effectively, "How to Submit Unanswerable Questions to Open Source Projects", better questions are easier to get help. (This paragraph refers to antd)

About Pull Request:

❤️ Contributors

Special thanks to everyone who contributed to this project.

lowcode-engine (alibaba/lowcode-engine)

Searching Database…

这是做什么用的?阿里巴巴开源的企业级低代码技术体系:一个内核引擎,采用可扩展的设计,你可以基于它扩展出自己的低代码平台。
它是一个拿来就能用的编辑器,还是让我搭建自己平台的基础?它是一个引擎,不是现成的应用:这是从一个企业级低代码平台中抽离出来的、面向扩展的内核,理念是“最小内核,最强生态”。
怎么把它加到网页里?通过 CDN 引入——运行时只支持 CDN 引入;npm 包只提供类型定义和代码提示。可以选择 alifd、uipaas、unpkg、jsdelivr 或你自己的 CDN。
在本地开发它需要装什么?构建工具链需要 Node.js 14.17.0 到 18 之前的版本(不含 18)。直接用 npm 在某些地区可能很慢,所以 README 建议改用 cnpm 或镜像源。
我用的是 Windows,想改它的代码,有什么要注意的坑?有:在 Windows 上必须在 WSL 里开发,其他终端不保证能正常工作。调试也不是直接的——引擎输出的是 UMD 文件,需要配合单独的 lowcode-demo 项目一起测试。
它能在哪些浏览器里运行?现代浏览器:Chrome 和 Edge 从 80 版起,加上最近两个版本的 Safari 和 Firefox。
不用看文档就能先试一下吗?可以——官网链接了一个在线演示('Play Now'),不用安装任何东西就能先在浏览器里把玩一下编辑器。
它的生态提供了哪些建筑模块?开箱即用的物料(materials)、属性设置器(setters)和插件,外加一套覆盖这些元素完整研发周期的工具链。awesome-lowcode-engine 页面则收录了社区的工具、物料和解决方案。
它的使用范围有多广?它的扩展能力已经支撑了近 100 个垂直领域的低代码平台,内核本身也是从阿里巴巴自己的企业级平台中抽离出来的。
它实现的那些协议规范对我来说意味着什么?它完整实现了 LowCodeEngine 基础搭建协议和物料协议——这些共享规范让物料可以在不同低代码平台之间流通,生态元素因此保持可移植。
What are similar projects?mitosis, amis, rete, taro, awesome-lowcode, backstage, illa-builder, puck
Creator
alibaba
Size
52.1 MB
Stars
15.9K
Age
4y
Commits · 90 Days