packages/engine/README.md

This project is forked from [alibaba/lowcode-engine](https://github.com/alibaba/lowcode-engine) (v1.3.2 on September 6, 2024).

Since the original project's version 1 has been determined to no longer have community open source maintenance, and there is no definite plan for version 2. Therefore, this project was born, and it is expected to continue open source maintenance.

Of course, from now on, related designs will also be completely independent and not related to the design of the original project's version 2. If you expect to continue following the original project's version 2 route in the future, please choose this project carefully.

This project will change some ideas, abandon some peripheral function development, mainly provide core low-code functions, and be a pure low-code kernel. Modules such as workspace will have a lower priority.

More internal modules will be transferred to plugins (incomplete) and provided as default plugins instead of being encapsulated inside. The overall development direction is shifting towards a more open one.

At the same time, for each sub-module, more interfaces will be opened through the shell module to support more customized needs.

Finally, the toolchain will be upgraded as appropriate. It is planned to switch to a newer packaging tool, etc., but the priority will be relatively low.

Currently, the project has just been forked. The main work is to replace the namespace. To avoid naming conflicts with the original project, the namespace of this repository is adjusted to `@felce`, which is taken from the abbreviation of lowcode-engine.

Current main tasks:

- Adjust the namespace of the main project.

- Fix backlogged issues.

<h1 align="center">LowCodeEngine</h1>

<div align="center">

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

[![NPM version][npm-image]][npm-url] [![NPM downloads][download-image]][download-url]

[![][issues-helper-image]][issues-helper-url] [![Issues need help][help-wanted-image]][help-wanted-url]

[![codecov][codecov-image-url]][codecov-url] [](https://github.com/lowcode-workspace/awesome-lowcode-engine)

[npm-image]: https://img.shields.io/npm/v/@felce/lowcode-engine.svg?style=flat-square

[npm-url]: http://npmjs.org/package/@felce/lowcode-engine

[download-image]: https://img.shields.io/npm/dm/@felce/lowcode-engine.svg?style=flat-square

[download-url]: https://npmjs.org/package/@felce/lowcode-engine

[help-wanted-image]: https://flat.badgen.net/github/label-issues/fe-lce/lowcode-engine/help%20wanted/open

[help-wanted-url]: https://github.com/fe-lce/lowcode-engine/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22

[issues-helper-image]: https://img.shields.io/badge/using-issues--helper-orange?style=flat-square

[issues-helper-url]: https://github.com/actions-cool/issues-helper

[codecov-image-url]: https://codecov.io/gh/fe-lce/lowcode-engine/branch/main/graph/badge.svg

[codecov-url]: https://codecov.io/gh/fe-lce/lowcode-engine

</div>

English | [简体中文](./packages/engine/README-zh_CN.md)

- 🌈 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

- Modern browsers (Chrome >= 80, Edge >= 80, last 2 safari versions, last 2 firefox versions)

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.


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

import { init, skeleton } from '@felce/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'));

{

"externals": {

"@felce/lowcode-engine": "var window.AliLowCodeEngine",

"@alilc/lowcode-engine-ext": "var window.AliLowCodeEngineExt"

}

}

https://unpkg.com/@felce/lowcode-engine@1.4.0-beta.0/dist/js/engine-core.js

https://unpkg.com/@felce/lowcode-react-simulator-renderer@1.4.0-beta.0/dist/js/react-simulator-renderer.js

https://registry.npmmirror.com/@felce/lowcode-engine/1.4.0-beta.0/files/dist/js/engine-core.js

https://registry.npmmirror.com/@felce/lowcode-react-simulator-renderer/1.4.0-beta.0/files/dist/js/react-simulator-renderer.js

https://cdn.jsdelivr.net/npm/@felce/lowcode-engine@1.4.0-beta.0/dist/js/engine-core.js

https://cdn.jsdelivr.net/npm/@felce/lowcode-react-simulator-renderer@1.4.0-beta.0/dist/js/react-simulator-renderer.js

Pass the files under packages/engine/dist and packages/react-simulator-renderer/dist in the source code to your cdn provider

- [Official website home page](http://lowcode-engine.cn/)

- [Demo Play Now](http://lowcode-engine.cn/demo) | [Engine Demo Repository](https://github.com/fe-lce/lowcode-demo)

- [Official Materials](https://github.com/fe-lce/lowcode-materials)

- [official setter](https://github.com/fe-lce/lowcode-engine-ext)

- [Official plugin (plugin)](https://github.com/fe-lce/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.

$ git clone git@github.com:fe-lce/lowcode-engine.git

$ cd lowcode-engine

$ npm install

$ npm run setup

$ npm start

After lowcode-engine is started, several umd files are provided, which can be debugged in combination with the [lowcode-demo](https://github.com/fe-lce/lowcode-demo) project. Refer to the file proxy rules [here](https://lowcode-engine.cn/site/docs/participate/prepare).

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)

About Pull Request:

- set the target branch to **develop** other than **main**

Special thanks to everyone who contributed to this project.

<p>

<a href="https://github.com/fe-lce/lowcode-engine/graphs/contributors"><img src="https://contrib.rocks/image?repo=fe-lce/lowcode-engine" /></a>

</p>