LowCodeEngine
An enterprise-class low-code technology stack with scale-out design
[![NPM version][npm-image]][npm-url] [![NPM downloads][download-image]][download-url]
[![][issues-helper-image]][issues-helper-url] [![Issues need help][help-wanted-image]][help-wanted-url]
[![codecov][codecov-image-url]][codecov-url] [](https://github.com/lowcode-workspace/awesome-lowcode-engine)
[](https://opensource.alibaba.com/contribution_leaderboard/details?projectValue=lowcode-engine)
[npm-image]: https://img.shields.io/npm/v/@rchh/lowcode-engine.svg?style=flat-square
[npm-url]: http://npmjs.org/package/@rchh/lowcode-engine
[download-image]: https://img.shields.io/npm/dm/@rchh/lowcode-engine.svg?style=flat-square
[download-url]: https://npmjs.org/package/@rchh/lowcode-engine
[help-wanted-image]: https://flat.badgen.net/github/label-issues/alibaba/lowcode-engine/help%20wanted/open
[help-wanted-url]: https://github.com/alibaba/lowcode-engine/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22
[issues-helper-image]: https://img.shields.io/badge/using-issues--helper-orange?style=flat-square
[issues-helper-url]: https://github.com/actions-cool/issues-helper
[codecov-image-url]: https://codecov.io/gh/alibaba/lowcode-engine/branch/main/graph/badge.svg
[codecov-url]: https://codecov.io/gh/alibaba/lowcode-engine
[](https://ratanachh.github.io/lowcode-engine/)
English | [简体中文](./packages/engine/README-zh_CN.md)
## ✨ Features
- 🌈 An extension-oriented kernel engine extracted from an enterprise-level low-code platform, pursuing the design concept of the smallest kernel and the strongest ecology
- 📦 Out-of-the-box high-quality ecological elements, including material systems, setters, plugins, etc.
- ⚙️ A complete tool chain, supporting the full-link R&D cycle of ecological elements such as material systems, setters, and plug-ins
- 🔌 Powerful expansion capability, has supported nearly 100 various vertical low-code platforms
- 🛡 Developed with TypeScript, providing complete type definition files
## 🎯 Compatible Environments
- Modern browsers (Chrome >= 80, Edge >= 80, last 2 safari versions, last 2 firefox versions)
## 📚 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.
## 🌰 Usage example
```bash
npm install @rchh/lowcode-engine --save-dev
```
> **TIPS: Only cdn import is supported, npm package is used to provide code hinting capabilities such as typings**
```ts
import { init, skeleton } from '@rchh/lowcode-engine';
skeleton.add({
area: 'topArea',
type: 'Widget',
name: 'logo',
content: YourFantasticLogo,
contentProps: {
logo:
'https://raw.githubusercontent.com/ratanachh/lowcode-engine/main/docs/static/img/logo-widget.png',
href: '/',
},
props: {
align: 'left',
width: 100,
},
});
init(document.getElementById('lce'));
```
### Engineering configuration:
```json
{
"externals": {
"@rchh/lowcode-engine": "var window.AliLowCodeEngine",
"@rchh/lowcode-engine-ext": "var window.AliLowCodeEngineExt"
}
}
```
### CDN options:
#### Method 1 (recommended): jsDelivr
```html
```
#### Method 2: unpkg
```html
```
#### Method 3: Use your own CDN
Upload the files under `packages/engine/dist` and `packages/react-simulator-renderer/dist` to your CDN provider.
## 🔗 Related Links
- [Official website home page](https://ratanachh.github.io/lowcode-engine/)
- [Demo Play Now](https://ratanachh.github.io/lowcode-engine/docs/guide/quickStart/demo) | [Engine Demo Repository](https://github.com/alibaba/lowcode-demo)
- [Official Materials](https://github.com/alibaba/lowcode-materials)
- [official setter](https://github.com/alibaba/lowcode-engine-ext)
- [Official plugin (plugin)](https://github.com/alibaba/lowcode-plugins)
- [Ecological elements (materials, setters, plugins) toolchain](https://ratanachh.github.io/lowcode-engine/docs/guide/expand/editor/cli)
- [User Documentation](https://ratanachh.github.io/lowcode-engine/docs/guide/quickStart/start)
- [API](https://ratanachh.github.io/lowcode-engine/docs/api)
This [awesome-lowcode-engine](https://github.com/lowcode-workspace/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
```bash
$ git clone git@github.com: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](https://docs.microsoft.com/en-us/windows/wsl/install), 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](https://github.com/alibaba/lowcode-demo) project. Refer to the file proxy rules [here](https://ratanachh.github.io/lowcode-engine/docs/participate/prepare).
## 🤝 Participation
Please read first:
1. [How to configure the engine debugging environment? ](https://ratanachh.github.io/lowcode-engine/docs/participate/prepare)
2. [About the R&D collaboration process of the engine](https://ratanachh.github.io/lowcode-engine/docs/participate/flow)
3. [Engineering Configuration of Engine](https://ratanachh.github.io/lowcode-engine/docs/participate/config)
> Strongly recommend reading ["The Wisdom of Asking Questions"](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way), ["How to Ask Questions to the Open Source Community"](https: //github.com/seajs/seajs/issues/545) and [How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/%7Esgtatham/bugs-cn.html), [ "How to Submit Unanswerable Questions to Open Source Projects"](https://zhuanlan.zhihu.com/p/25795393), better questions are easier to get help. (This paragraph refers to [antd](https://github.com/ant-design/ant-design))
About Pull Request:
- set the target branch to **develop** other than **main**