lowcode-engine

LowCodeEngine

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 @alilc/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 '@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: ```json { "externals": { "@alilc/lowcode-engine": "var window.AliLowCodeEngine", "@alilc/lowcode-engine-ext": "var window.AliLowCodeEngineExt" } } ``` ### cdn optional method: #### Method 1: alifd cdn ```html 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 ```html 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 ```html 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 ```html 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 ## 🔗 Related Links - [Official website home page](http://lowcode-engine.cn/) - [Demo Play Now](http://lowcode-engine.cn/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://lowcode-engine.cn/site/docs/guide/expand/editor/cli) - [User Documentation](http://lowcode-engine.cn/doc) - [API](https://lowcode-engine.cn/site/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 [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](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://lowcode-engine.cn/site/docs/participate/prepare). ## 🤝 Participation Please read first: 1. [How to configure the engine debugging environment? ](https://lowcode-engine.cn/site/docs/participate/prepare) 2. [About the R&D collaboration process of the engine](https://lowcode-engine.cn/site/docs/participate/flow) 3. [Engineering Configuration of Engine](https://lowcode-engine.cn/site/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** ## ❤️ Contributors Special thanks to everyone who contributed to this project.