lowcode-engine README

The project's README from github.com/alibaba/lowcode-engine. As one markdown file: README.md.

LowCodeEngine

An enterprise-class low-code technology stack with scale-out design

NPM version NPM downloads

Issues need help

codecov Awesome

English | 简体中文

✨ Features

🎯 Compatible Environments

📚 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.

image

🌰 Usage example

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

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:

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

cdn optional method:

Method 1: alifd cdn

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

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

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

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

This 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

$ 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, 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 project. Refer to the file proxy rules here.

🤝 Participation

Please read first:

  1. How to configure the engine debugging environment?
  2. About the R&D collaboration process of the engine
  3. Engineering Configuration of Engine

Strongly recommend reading "The Wisdom of Asking Questions", ["How to Ask Questions to the Open Source Community"](https: //github.com/seajs/seajs/issues/545) and How to Report Bugs Effectively, "How to Submit Unanswerable Questions to Open Source Projects", better questions are easier to get help. (This paragraph refers to antd)

About Pull Request:

❤️ Contributors

Special thanks to everyone who contributed to this project.

lowcode-engine (alibaba/lowcode-engine)

Searching Database…

Что это такое?Опенсорсный корпоративный low-code стек от Alibaba: движок-ядро с расширяемой архитектурой, на основе которого вы можете построить собственную low-code платформу.
Это готовый редактор, которым я пользуюсь, или база, на которой я строю свою платформу?Это движок, а не готовое приложение: ядро, ориентированное на расширение, извлечённое из корпоративной low-code платформы и построенное вокруг идеи «минимальное ядро — максимальная экосистема».
Как подключить его к веб-странице?Подключите его с CDN — в рантайме поддерживается только импорт через CDN; npm-пакет даёт лишь типы и подсказки в коде. Варианты: alifd, uipaas, unpkg, jsdelivr или свой CDN.
Что нужно установить, чтобы работать с ним локально?Node.js от 14.17.0 до 18 (не включая) для сборочного инструментария. Обычный npm может работать медленно в зависимости от региона, поэтому в README советуют cnpm или зеркальный registry.
У меня Windows и я хочу покопаться в коде — есть подводные камни?Да: на Windows разработка возможна только внутри WSL — работа в других терминалах не гарантируется. Отладка тоже непрямая: движок собирает UMD-файлы, которые тестируются вместе с отдельным проектом lowcode-demo.
В каких браузерах он работает?В современных: Chrome и Edge начиная с версии 80, а также две последние версии Safari и Firefox.
Можно попробовать до чтения документации?Да — на официальном сайте есть ссылка на живое демо («Play Now»), так что можно пощупать редактор прямо в браузере, ничего не устанавливая.
Какие строительные блоки даёт его экосистема?Готовые материалы (materials), сеттеры и плагины, плюс полный набор инструментов, покрывающий весь цикл разработки этих элементов. Страница awesome-lowcode-engine собирает инструменты, материалы и решения сообщества.
Насколько широко он распространился?Возможности расширения обеспечили работу почти 100 отраслевых low-code платформ, а само ядро было извлечено из собственной корпоративной платформы Alibaba.
Что мне дают реализованные в нём спецификации протоколов?Он полностью реализует LowCodeEngine Basic Construction Protocol и Material Protocol — общие спецификации, благодаря которым материалы могут циркулировать между low-code платформами, то есть элементы экосистемы остаются переносимыми.
What are similar projects?mitosis, amis, rete, taro, awesome-lowcode, backstage, illa-builder, puck
Creator
alibaba
Size
52.1 MB
Stars
15.9K
Age
4y
Commits · 90 Days