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…

What is this?Alibaba's open-source, enterprise-class low-code technology stack: a kernel engine with a scale-out design that you extend to build your own low-code platforms.
Is this a finished editor I use, or a foundation I build my own platform on?It is an engine, not a ready app: an extension-oriented kernel extracted from an enterprise low-code platform, built around the idea of the smallest kernel with the strongest ecosystem.
How do I add it to a web page?Import it from a CDN — only CDN import is supported at runtime; the npm package just provides typings and code hints. Options include alifd, uipaas, unpkg, jsdelivr or your own CDN.
What do I need installed to work on it locally?Node.js 14.17.0 up to (but not including) 18 for the build toolchain. Plain npm can be slow depending on your region, so the README suggests cnpm or a mirror registry instead.
I'm on Windows and want to hack on it — any gotchas?Yes: on Windows you must develop inside WSL, as other terminals are not guaranteed to work. Debugging is also indirect — the engine emits UMD files that you test together with the separate lowcode-demo project.
Which browsers does it run in?Modern browsers: Chrome and Edge from version 80, plus the last two releases of Safari and Firefox.
Can I try it before reading any docs?Yes — the official site links a live demo ('Play Now'), so you can poke at the editor in the browser before installing anything.
What kinds of building blocks does its ecosystem provide?Out-of-the-box materials, setters and plugins, plus a complete toolchain covering the full R&D cycle of those elements. An awesome-lowcode-engine page catalogs community tools, materials and solutions.
How widely has it been adopted?Its expansion capability has supported nearly 100 vertical low-code platforms, and the kernel itself was extracted from Alibaba's own enterprise-level platform.
What do the protocol specs it implements mean for me?It fully implements the LowCodeEngine Basic Construction Protocol and the Material Protocol — shared specifications that let materials circulate between low-code platforms, so ecosystem elements stay portable.
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