Skip to content

Latest commit

 

History

History
169 lines (121 loc) · 6.57 KB

README-zh_CN.md

File metadata and controls

169 lines (121 loc) · 6.57 KB
Raw

LowCodeEngine

一套面向扩展设计的企业级低代码技术体系

NPM version NPM downloads

Issues need help

codecov

简体中文 | English

✨ 特性

  • 🌈 提炼自企业级低代码平台的面向扩展设计的内核引擎，奉行最小内核，最强生态的设计理念
  • 📦 开箱即用的高质量生态元素，包括 物料体系、设置器、插件 等
  • ⚙️ 完善的工具链，支持 物料体系、设置器、插件 等生态元素的全链路研发周期
  • 🔌 强大的扩展能力，已支撑近 100 个各种垂直类低代码平台
  • 🛡 使用 TypeScript 开发，提供完整的类型定义文件

🎯 兼容环境

  • 现代浏览器（Chrome >= 80, Edge >= 80, last 2 safari versions, last 2 firefox versions）

📚 引擎协议

引擎完整实现了《低代码引擎搭建协议规范》和《低代码引擎物料协议规范》，协议栈是低代码领域的物料能否流通的关键部分。

image

🌰 使用示例

npm install @alilc/lowcode-engine --save-dev

TIPS：仅支持 cdn 方式引入，npm 包用于提供 typings 等代码提示能力

import { init, skeleton } from '@alilc/lowcode-engine';

skeleton.add({
  area: 'topArea',
  type: 'Widget',
  name: 'logo',
  content: YourFantaticLogo,
  contentProps: {
    logo:
      'https://img.alicdn.com/tfs/TB1_SocGkT2gK0jSZFkXXcIQFXa-66-66.png',
    href: '/',
  },
  props: {
    align: 'left',
    width: 100,
  },
});

init(document.getElementById('lce'));

工程化配置：

{
  "externals": {
    "@alilc/lowcode-engine": "var window.AliLowCodeEngine",
    "@alilc/lowcode-engine-ext": "var window.AliLowCodeEngineExt"
  }
}

cdn 可选方式：

方式 1（推荐）：alifd cdn

https://alifd.alicdn.com/npm/@alilc/lowcode-engine@1.0.0/dist/js/engine-core.js

https://alifd.alicdn.com/npm/@alilc/lowcode-react-simulator-renderer@1.0.0/dist/js/react-simulator-renderer.js

方式 2：unpkg

https://unpkg.com/@alilc/lowcode-engine@1.0.0/dist/js/engine-core.js

https://unpkg.com/@alilc/lowcode-react-simulator-renderer@1.0.0/dist/js/react-simulator-renderer.js

方式 3：jsdelivr

https://cdn.jsdelivr.net/npm/@alilc/lowcode-engine@1.0.0/dist/js/engine-core.js

https://cdn.jsdelivr.net/npm/@alilc/lowcode-react-simulator-renderer@1.0.0/dist/js/react-simulator-renderer.js

方式 4：使用自有 cdn

将源码中 packages/engine/dist 和 packages/(react|rax)-simulator-renderer/dist 下的文件传至你的 cdn 提供商

🔗 相关链接

awesome-lowcode-engine 中包含了一系列围绕引擎建设的工具、解决方案等，如果你有类似的解决方案或者工具，欢迎提 PR 到该仓库，让更多人了解到

💻 本地调试

$ git clone git@github.com:alibaba/lowcode-engine.git
$ cd lowcode-engine
$ npm install
$ npm run setup
$ npm start

📢 npm 访问速度较慢，阿里员工可以使用 tnpm，其他同学建议使用 cnpm 或者指定镜像 registry。

📢 windows 环境必须使用 WSL，其他终端不保证能正常运行

lowcode-engine 启动后，提供了几个 umd 文件，可以结合 lowcode-demo 项目做调试，文件代理规则参考这里。

🤝 参与共建

请先阅读：

  1. 如何配置引擎调试环境？
  2. 关于引擎的研发协作流程
  3. 引擎的工程化配置

强烈推荐阅读 《提问的智慧》、《如何向开源社区提问题》 和 《如何有效地报告 Bug》、《如何向开源项目提交无法解答的问题》，更好的问题更容易获得帮助。（此段参考 antd）

关于提交 PR： 请将目标合并分支设置为 develop，不要指定 main 分支，在发布正式版本后，develop 分支将会合入 main 分支。

❤️ 致谢

感谢所有为引擎项目贡献力量的同学们~