\n\n[](http://lowcode-engine.cn)\n\nEnglish | [简体中文](./packages/engine/README-zh_CN.md)\n\n## ✨ Features\n\n- 🌈 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\n- 📦 Out-of-the-box high-quality ecological elements, including material systems, setters, plugins, etc.\n- ⚙️ A complete tool chain, supporting the full-link R&D cycle of ecological elements such as material systems, setters, and plug-ins\n- 🔌 Powerful expansion capability, has supported nearly 100 various vertical low-code platforms\n- 🛡 Developed with TypeScript, providing complete type definition files\n\n## 🎯 Compatible Environments\n\n- Modern browsers (Chrome >= 80, Edge >= 80, last 2 safari versions, last 2 firefox versions)\n\n## 📚 Engine Protocol\n\nThe 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.\n\n\n\n## 🌰 Usage example\n\n```bash\nnpm install @alilc/lowcode-engine --save-dev\n```\n\n> **TIPS: Only cdn import is supported, npm package is used to provide code hinting capabilities such as typings**\n\n```ts\nimport { init, skeleton } from '@alilc/lowcode-engine';\n\nskeleton.add({\n area: 'topArea',\n type: 'Widget',\n name: 'logo',\n content: YourFantasticLogo,\n contentProps: {\n logo:\n 'https://img.alicdn.com/tfs/TB1_SocGkT2gK0jSZFkXXcIQFXa-66-66.png',\n href: '/',\n },\n props: {\n align: 'left',\n width: 100,\n },\n});\n\ninit(document.getElementById('lce'));\n```\n\n### Engineering configuration:\n```json\n{\n \"externals\": {\n \"@alilc/lowcode-engine\": \"var window.AliLowCodeEngine\",\n \"@alilc/lowcode-engine-ext\": \"var window.AliLowCodeEngineExt\"\n }\n}\n```\n\n### cdn optional method:\n#### Method 1: alifd cdn\n```html\nhttps://alifd.alicdn.com/npm/@alilc/lowcode-engine@1.0.18/dist/js/engine-core.js\n\nhttps://alifd.alicdn.com/npm/@alilc/lowcode-react-simulator-renderer@1.0.18/dist/js/react-simulator-renderer.js\n```\n\n#### Method 2: uipaas cdn\n```html\nhttps://uipaas-assets.com/prod/npm/@alilc/lowcode-engine/1.0.18/dist/js/engine-core.js\n\nhttps://uipaas-assets.com/prod/npm/@alilc/lowcode-react-simulator-renderer/1.0.18/dist/js/react-simulator-renderer.js\n```\n\n#### Method 3: unpkg\n```html\nhttps://unpkg.com/@alilc/lowcode-engine@1.0.18/dist/js/engine-core.js\n\nhttps://unpkg.com/@alilc/lowcode-react-simulator-renderer@1.0.18/dist/js/react-simulator-renderer.js\n```\n\n#### Method 4: jsdelivr\n```html\nhttps://cdn.jsdelivr.net/npm/@alilc/lowcode-engine@1.0.18/dist/js/engine-core.js\n\nhttps://cdn.jsdelivr.net/npm/@alilc/lowcode-react-simulator-renderer@1.0.18/dist/js/react-simulator-renderer.js\n```\n\n#### Method 5: Use your own cdn\nPass the files under packages/engine/dist and packages/react-simulator-renderer/dist in the source code to your cdn provider\n\n## 🔗 Related Links\n\n- [Official website home page](http://lowcode-engine.cn/)\n- [Demo Play Now](http://lowcode-engine.cn/demo) | [Engine Demo Repository](https://github.com/alibaba/lowcode-demo)\n- [Official Materials](https://github.com/alibaba/lowcode-materials)\n- [official setter](https://github.com/alibaba/lowcode-engine-ext)\n- [Official plugin (plugin)](https://github.com/alibaba/lowcode-plugins)\n- [Ecological elements (materials, setters, plugins) toolchain](https://lowcode-engine.cn/site/docs/guide/expand/editor/cli)\n- [User Documentation](http://lowcode-engine.cn/doc)\n- [API](https://lowcode-engine.cn/site/docs/api/)\n\nThis [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.\n\n## 💻 Local debugging\n\n```bash\n$ git clone git@github.com:alibaba/lowcode-engine.git\n$ cd lowcode-engine\n$ npm install\n$ npm run setup\n$ npm start\n```\n\n> 📢 npm access speed is slow, Alibaba employees can use tnpm, other students recommend using cnpm or specifying a mirror registry.\n>\n> 📢 Windows environment must use [WSL](https://docs.microsoft.com/en-us/windows/wsl/install), other terminals are not guaranteed to work normally\n\nAfter 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).\n\n## 🤝 Participation\n\nPlease read first:\n1. [How to configure the engine debugging environment? ](https://lowcode-engine.cn/site/docs/participate)\n2. [About the R&D collaboration process of the engine](https://lowcode-engine.cn/site/docs/participate/flow)\n\n> 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))\n\nAbout Pull Request:\n- set the target branch to **develop** other than **main**\n\n## ❤️ Contributors\n\nSpecial thanks to everyone who contributed to this project.\n\n
![](\"https://img.alicdn.com/imgextra/i3/O1CN01i8K9cD1d0HU7TjDtv_!!6000000003673-2-tps-500-591.png\")
\n \n