|
| 1 | +<p align="center"> |
| 2 | + <a href="http://lowcode-engine.cn"> |
| 3 | + <img width="200" src="https://img.alicdn.com/imgextra/i3/O1CN01i8K9cD1d0HU7TjDtv_!!6000000003673-2-tps-500-591.png"> |
| 4 | + </a> |
| 5 | +</p> |
| 6 | + |
| 7 | +<h1 align="center">LowCodeEngine</h1> |
| 8 | + |
| 9 | +<div align="center"> |
| 10 | + |
| 11 | +An enterprise-class low-code technology stack for scale-out design |
| 12 | + |
| 13 | +[![NPM version][npm-image]][npm-url] [![NPM downloads][download-image]][download-url] |
| 14 | + |
| 15 | +[![Discussions][discussions-image]][discussions-url] [![][issues-helper-image]][issues-helper-url] [![Issues need help][help-wanted-image]][help-wanted-url] |
| 16 | + |
| 17 | +[npm-image]: https://img.shields.io/npm/v/@alilc/lowcode-engine.svg?style=flat-square |
| 18 | +[npm-url]: http://npmjs.org/package/@alilc/lowcode-engine |
| 19 | + |
| 20 | +[download-image]: https://img.shields.io/npm/dm/@alilc/lowcode-engine.svg?style=flat-square |
| 21 | +[download-url]: https://npmjs.org/package/@alilc/lowcode-engine |
| 22 | +[help-wanted-image]: https://flat.badgen.net/github/label-issues/alibaba/lowcode-engine/help%20wanted/open |
| 23 | +[help-wanted-url]: https://github.com/alibaba/lowcode-engine/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22 |
| 24 | +[discussions-image]: https://img.shields.io/badge/discussions-on%20github-blue?style=flat-square |
| 25 | +[discussions-url]: https://github.com/alibaba/lowcode-engine/discussions |
| 26 | + |
| 27 | +[issues-helper-image]: https://img.shields.io/badge/using-issues--helper-orange?style=flat-square |
| 28 | +[issues-helper-url]: https://github.com/actions-cool/issues-helper |
| 29 | + |
| 30 | +</div> |
| 31 | + |
| 32 | +[](http://lowcode-engine.cn) |
| 33 | + |
| 34 | +English | [简体中文](./README-zh_CN.md) |
| 35 | + |
| 36 | +## ✨ Features |
| 37 | + |
| 38 | +- 🌈 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 |
| 39 | +- 📦 Out-of-the-box high-quality ecological elements, including material systems, setters, plugins, etc. |
| 40 | +- ⚙️ A complete tool chain, supporting the full-link R&D cycle of ecological elements such as material systems, setters, and plug-ins |
| 41 | +- 🔌 Powerful expansion capability, has supported nearly 100 various vertical low-code platforms |
| 42 | +- 🛡 Developed with TypeScript, providing complete type definition files |
| 43 | + |
| 44 | +## 🎯 Compatible Environments |
| 45 | + |
| 46 | +- Modern browsers (Chrome >= 80, Edge >= 80, last 2 safari versions, last 2 firefox versions) |
| 47 | + |
| 48 | +## 📚 Engine Protocol |
| 49 | + |
| 50 | +The engine fully implements the "Alibaba Mid-Backend Front-End Basic Construction Protocol Specification" and "Alibaba Mid-Backend Front-End Material Protocol Specification". The protocol stack is a key part of whether materials in the low-code field can be circulated. |
| 51 | + |
| 52 | + |
| 53 | + |
| 54 | +## 🌰 Usage example |
| 55 | + |
| 56 | +```bash |
| 57 | +npm install @alilc/lowcode-engine --save-dev |
| 58 | +``` |
| 59 | + |
| 60 | +> **TIPS: Only cdn import is supported, npm package is used to provide code hinting capabilities such as typings** |
| 61 | +
|
| 62 | +```ts |
| 63 | +import { init, skeleton } from '@alilc/lowcode-engine'; |
| 64 | + |
| 65 | +skeleton.add({ |
| 66 | + area: 'topArea', |
| 67 | + type: 'Widget', |
| 68 | + name: 'logo', |
| 69 | + content: YourFantaticLogo, |
| 70 | + contentProps: { |
| 71 | + logo: |
| 72 | + 'https://img.alicdn.com/tfs/TB1_SocGkT2gK0jSZFkXXcIQFXa-66-66.png', |
| 73 | + href: '/', |
| 74 | + }, |
| 75 | + props: { |
| 76 | + align: 'left', |
| 77 | + width: 100, |
| 78 | + }, |
| 79 | +}); |
| 80 | + |
| 81 | +init(document.getElementById('lce')); |
| 82 | +``` |
| 83 | + |
| 84 | +### Engineering configuration: |
| 85 | +```json |
| 86 | +{ |
| 87 | + "externals": { |
| 88 | + "@alilc/lowcode-engine": "var window.AliLowCodeEngine", |
| 89 | + "@alilc/lowcode-engine-ext": "var window.AliLowCodeEngineExt" |
| 90 | + } |
| 91 | +} |
| 92 | +``` |
| 93 | + |
| 94 | +### cdn optional method: |
| 95 | +#### Method 1: alifd cdn |
| 96 | +```html |
| 97 | +https://alifd.alicdn.com/npm/@alilc/lowcode-engine@1.0.0/dist/js/engine-core.js |
| 98 | + |
| 99 | +https://alifd.alicdn.com/npm/@alilc/lowcode-react-simulator-renderer@1.0.0/dist/js/react-simulator-renderer.js |
| 100 | +``` |
| 101 | + |
| 102 | +#### Method 2: unpkg |
| 103 | +```html |
| 104 | +https://unpkg.com/@alilc/lowcode-engine@1.0.0/dist/js/engine-core.js |
| 105 | + |
| 106 | +https://unpkg.com/@alilc/lowcode-react-simulator-renderer@1.0.0/dist/js/react-simulator-renderer.js |
| 107 | +``` |
| 108 | + |
| 109 | +#### Method 3: jsdelivr |
| 110 | +```html |
| 111 | +https://cdn.jsdelivr.net/npm/@alilc/lowcode-engine@1.0.0/dist/js/engine-core.js |
| 112 | + |
| 113 | +https://cdn.jsdelivr.net/npm/@alilc/lowcode-react-simulator-renderer@1.0.0/dist/js/react-simulator-renderer.js |
| 114 | +``` |
| 115 | + |
| 116 | +#### Method 4: Use your own cdn |
| 117 | +Pass the files under packages/engine/dist and packages/(react|rax)-simulator-renderer/dist in the source code to your cdn provider |
| 118 | + |
| 119 | +## 🔗 Related Links |
| 120 | + |
| 121 | +- [Official website home page](http://lowcode-engine.cn/) |
| 122 | +- [Demo Play Now](http://lowcode-engine.cn/demo) | [Engine Demo Repository](https://github.com/alibaba/lowcode-demo) |
| 123 | +- [Official Materials](https://github.com/alibaba/lowcode-materials) |
| 124 | +- [official setter](https://github.com/alibaba/lowcode-engine-ext) |
| 125 | +- [Official plugin (plugin)](https://github.com/alibaba/lowcode-plugins) |
| 126 | +- [Ecological elements (materials, setters, plugins) toolchain](https://www.yuque.com/lce/doc/ulvlkz) |
| 127 | +- [User Documentation](http://lowcode-engine.cn/doc) |
| 128 | +- [API [WIP]](http://lowcode-engine.cn/doc?url=vlmeme) |
| 129 | + |
| 130 | +## 💻 Local debugging |
| 131 | + |
| 132 | +```bash |
| 133 | +$ git clone git@github.com: alibaba/lowcode-engine.git |
| 134 | +$ cd lowcode-engine |
| 135 | +$ npm install |
| 136 | +$ npm run setup |
| 137 | +$ npm start |
| 138 | +``` |
| 139 | + |
| 140 | +> 📢 npm access speed is slow, Alibaba employees can use tnpm, other students recommend using cnpm or specifying a mirror registry. |
| 141 | +> |
| 142 | +> 📢 node version limited to 14 |
| 143 | +> |
| 144 | +> 📢 Windows environment must use [WSL](https://docs.microsoft.com/zh-cn/windows/wsl/install), other terminals are not guaranteed to work normally |
| 145 | +
|
| 146 | +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:/ /www.yuque.com/lce/doc/glz0fx). |
| 147 | + |
| 148 | +## 🤝 Participate in co-construction |
| 149 | + |
| 150 | +Please read first: |
| 151 | +1. [How to configure the engine debugging environment? ](https://www.yuque.com/lce/doc/glz0fx) |
| 152 | +2. [About the R&D collaboration process of the engine](https://www.yuque.com/lce/doc/contributing) |
| 153 | +3. [Engineering Configuration of Engine](https://www.yuque.com/lce/doc/gxwqg6) |
| 154 | + |
| 155 | +> 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)) |
0 commit comments