chore: switch the readme file type due to symbolic readme will not be included in npm package
This commit is contained in:
LeoYuan 袁力皓
parent
9f9b2557b0
commit
a7bdc9d33e
155
README-zh_CN.md
155
README-zh_CN.md
|
|
@ -1,155 +0,0 @@
|
|||
<p align="center">
|
||||
<a href="https://lowcode-engine.cn">
|
||||
<img width="200" src="https://img.alicdn.com/imgextra/i3/O1CN01i8K9cD1d0HU7TjDtv_!!6000000003673-2-tps-500-591.png">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
<h1 align="center">LowCodeEngine</h1>
|
||||
|
||||
<div align="center">
|
||||
|
||||
一套面向扩展设计的企业级低代码技术体系
|
||||
|
||||
[![NPM version][npm-image]][npm-url] [![NPM downloads][download-image]][download-url]
|
||||
|
||||
[![Discussions][discussions-image]][discussions-url] [![][issues-helper-image]][issues-helper-url] [![Issues need help][help-wanted-image]][help-wanted-url]
|
||||
|
||||
[npm-image]: https://img.shields.io/npm/v/@alilc/lowcode-engine.svg?style=flat-square
|
||||
[npm-url]: http://npmjs.org/package/@alilc/lowcode-engine
|
||||
|
||||
[download-image]: https://img.shields.io/npm/dm/@alilc/lowcode-engine.svg?style=flat-square
|
||||
[download-url]: https://npmjs.org/package/@alilc/lowcode-engine
|
||||
[help-wanted-image]: https://flat.badgen.net/github/label-issues/alibaba/lowcode-engine/help%20wanted/open
|
||||
[help-wanted-url]: https://github.com/alibaba/lowcode-engine/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22
|
||||
[discussions-image]: https://img.shields.io/badge/discussions-on%20github-blue?style=flat-square
|
||||
[discussions-url]: https://github.com/alibaba/lowcode-engine/discussions
|
||||
|
||||
[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
|
||||
|
||||
</div>
|
||||
|
||||
[](https://lowcode-engine.cn)
|
||||
|
||||
简体中文 | [English](./README.md)
|
||||
|
||||
## ✨ 特性
|
||||
|
||||
- 🌈 提炼自企业级低代码平台的面向扩展设计的内核引擎，奉行最小内核，最强生态的设计理念
|
||||
- 📦 开箱即用的高质量生态元素，包括 物料体系、设置器、插件 等
|
||||
- ⚙️ 完善的工具链，支持 物料体系、设置器、插件 等生态元素的全链路研发周期
|
||||
- 🔌 强大的扩展能力，已支撑近 100 个各种垂直类低代码平台
|
||||
- 🛡 使用 TypeScript 开发，提供完整的类型定义文件
|
||||
|
||||
## 🎯 兼容环境
|
||||
|
||||
- 现代浏览器（Chrome >= 80, Edge >= 80, last 2 safari versions, last 2 firefox versions）
|
||||
|
||||
## 📚 引擎协议
|
||||
|
||||
引擎完整实现了《阿里巴巴中后台前端基础搭建协议规范》和《阿里巴巴中后台前端物料协议规范》，协议栈是低代码领域的物料能否流通的关键部分。
|
||||
|
||||
|
||||
|
||||
## 🌰 使用示例
|
||||
|
||||
```bash
|
||||
npm install @alilc/lowcode-engine --save-dev
|
||||
```
|
||||
|
||||
> **TIPS：仅支持 cdn 方式引入，npm 包用于提供 typings 等代码提示能力**
|
||||
|
||||
```ts
|
||||
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'));
|
||||
```
|
||||
|
||||
### 工程化配置：
|
||||
```json
|
||||
{
|
||||
"externals": {
|
||||
"@alilc/lowcode-engine": "var window.AliLowCodeEngine",
|
||||
"@alilc/lowcode-engine-ext": "var window.AliLowCodeEngineExt"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### cdn 可选方式：
|
||||
#### 方式 1（推荐）：alifd cdn
|
||||
```html
|
||||
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
|
||||
```html
|
||||
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
|
||||
```html
|
||||
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 提供商
|
||||
|
||||
## 🔗 相关链接
|
||||
|
||||
- [官网首页](https://lowcode-engine.cn/)
|
||||
- [Demo 马上玩](https://lowcode-engine.cn/demo) | [引擎 Demo 仓库](https://github.com/alibaba/lowcode-demo)
|
||||
- [官方物料](https://github.com/alibaba/lowcode-materials)
|
||||
- [官方设置器（setter）](https://github.com/alibaba/lowcode-engine-ext)
|
||||
- [官方插件（plugin）](https://github.com/alibaba/lowcode-plugins)
|
||||
- [生态元素（物料、setter、插件）工具链](https://www.yuque.com/lce/doc/ulvlkz)
|
||||
- [用户文档](https://lowcode-engine.cn/doc)
|
||||
- [API [WIP]](https://lowcode-engine.cn/doc?url=vlmeme)
|
||||
|
||||
## 💻 本地调试
|
||||
|
||||
```bash
|
||||
$ git clone git@github.com:alibaba/lowcode-engine.git
|
||||
$ cd lowcode-engine
|
||||
$ npm install
|
||||
$ npm run setup
|
||||
$ npm start
|
||||
```
|
||||
|
||||
> 📢 npm 访问速度较慢，阿里员工可以使用 tnpm，其他同学建议使用 cnpm 或者指定镜像 registry。
|
||||
>
|
||||
> 📢 node 版本限定在 14
|
||||
>
|
||||
> 📢 windows 环境必须使用 [WSL](https://docs.microsoft.com/zh-cn/windows/wsl/install)，其他终端不保证能正常运行
|
||||
|
||||
lowcode-engine 启动后，提供了几个 umd 文件，可以结合 [lowcode-demo](https://github.com/alibaba/lowcode-demo) 项目做调试，文件代理规则参考[这里](https://www.yuque.com/lce/doc/glz0fx)。
|
||||
|
||||
## 🤝 参与共建
|
||||
|
||||
请先阅读：
|
||||
1. [如何配置引擎调试环境？](https://www.yuque.com/lce/doc/glz0fx)
|
||||
2. [关于引擎的研发协作流程](https://www.yuque.com/lce/doc/contributing)
|
||||
3. [引擎的工程化配置](https://www.yuque.com/lce/doc/gxwqg6)
|
||||
|
||||
> 强烈推荐阅读 [《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way)、[《如何向开源社区提问题》](https://github.com/seajs/seajs/issues/545) 和 [《如何有效地报告 Bug》](http://www.chiark.greenend.org.uk/%7Esgtatham/bugs-cn.html)、[《如何向开源项目提交无法解答的问题》](https://zhuanlan.zhihu.com/p/25795393)，更好的问题更容易获得帮助。（此段参考 [antd](https://github.com/ant-design/ant-design)）
|
||||
|
|
@ -0,0 +1 @@
|
|||
packages/engine/README-zh_CN.md
|
||||
155
README.md
155
README.md
|
|
@ -1,155 +0,0 @@
|
|||
<p align="center">
|
||||
<a href="http://lowcode-engine.cn">
|
||||
<img width="200" src="https://img.alicdn.com/imgextra/i3/O1CN01i8K9cD1d0HU7TjDtv_!!6000000003673-2-tps-500-591.png">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
<h1 align="center">LowCodeEngine</h1>
|
||||
|
||||
<div align="center">
|
||||
|
||||
An enterprise-class low-code technology stack for scale-out design
|
||||
|
||||
[![NPM version][npm-image]][npm-url] [![NPM downloads][download-image]][download-url]
|
||||
|
||||
[![Discussions][discussions-image]][discussions-url] [![][issues-helper-image]][issues-helper-url] [![Issues need help][help-wanted-image]][help-wanted-url]
|
||||
|
||||
[npm-image]: https://img.shields.io/npm/v/@alilc/lowcode-engine.svg?style=flat-square
|
||||
[npm-url]: http://npmjs.org/package/@alilc/lowcode-engine
|
||||
|
||||
[download-image]: https://img.shields.io/npm/dm/@alilc/lowcode-engine.svg?style=flat-square
|
||||
[download-url]: https://npmjs.org/package/@alilc/lowcode-engine
|
||||
[help-wanted-image]: https://flat.badgen.net/github/label-issues/alibaba/lowcode-engine/help%20wanted/open
|
||||
[help-wanted-url]: https://github.com/alibaba/lowcode-engine/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22
|
||||
[discussions-image]: https://img.shields.io/badge/discussions-on%20github-blue?style=flat-square
|
||||
[discussions-url]: https://github.com/alibaba/lowcode-engine/discussions
|
||||
|
||||
[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
|
||||
|
||||
</div>
|
||||
|
||||
[](http://lowcode-engine.cn)
|
||||
|
||||
English | [简体中文](./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 "Alibaba Mid-Backend Front-End Basic Construction Protocol Specification" and "Alibaba Mid-Backend Front-End 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: YourFantaticLogo,
|
||||
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/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
|
||||
```
|
||||
|
||||
#### Method 2: unpkg
|
||||
```html
|
||||
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
|
||||
```
|
||||
|
||||
#### Method 3: jsdelivr
|
||||
```html
|
||||
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
|
||||
```
|
||||
|
||||
#### Method 4: Use your own cdn
|
||||
Pass the files under packages/engine/dist and packages/(react|rax)-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://www.yuque.com/lce/doc/ulvlkz)
|
||||
- [User Documentation](http://lowcode-engine.cn/doc)
|
||||
- [API [WIP]](http://lowcode-engine.cn/doc?url=vlmeme)
|
||||
|
||||
## 💻 Local debugging
|
||||
|
||||
```bash
|
||||
$ git clone git@github.com: 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.
|
||||
>
|
||||
> 📢 node version limited to 14
|
||||
>
|
||||
> 📢 Windows environment must use [WSL](https://docs.microsoft.com/zh-cn/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:/ /www.yuque.com/lce/doc/glz0fx).
|
||||
|
||||
## 🤝 Participate in co-construction
|
||||
|
||||
Please read first:
|
||||
1. [How to configure the engine debugging environment? ](https://www.yuque.com/lce/doc/glz0fx)
|
||||
2. [About the R&D collaboration process of the engine](https://www.yuque.com/lce/doc/contributing)
|
||||
3. [Engineering Configuration of Engine](https://www.yuque.com/lce/doc/gxwqg6)
|
||||
|
||||
> 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))
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../README-zh_CN.md
|
||||
|
|
@ -0,0 +1,155 @@
|
|||
<p align="center">
|
||||
<a href="https://lowcode-engine.cn">
|
||||
<img width="200" src="https://img.alicdn.com/imgextra/i3/O1CN01i8K9cD1d0HU7TjDtv_!!6000000003673-2-tps-500-591.png">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
<h1 align="center">LowCodeEngine</h1>
|
||||
|
||||
<div align="center">
|
||||
|
||||
一套面向扩展设计的企业级低代码技术体系
|
||||
|
||||
[![NPM version][npm-image]][npm-url] [![NPM downloads][download-image]][download-url]
|
||||
|
||||
[![Discussions][discussions-image]][discussions-url] [![][issues-helper-image]][issues-helper-url] [![Issues need help][help-wanted-image]][help-wanted-url]
|
||||
|
||||
[npm-image]: https://img.shields.io/npm/v/@alilc/lowcode-engine.svg?style=flat-square
|
||||
[npm-url]: http://npmjs.org/package/@alilc/lowcode-engine
|
||||
|
||||
[download-image]: https://img.shields.io/npm/dm/@alilc/lowcode-engine.svg?style=flat-square
|
||||
[download-url]: https://npmjs.org/package/@alilc/lowcode-engine
|
||||
[help-wanted-image]: https://flat.badgen.net/github/label-issues/alibaba/lowcode-engine/help%20wanted/open
|
||||
[help-wanted-url]: https://github.com/alibaba/lowcode-engine/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22
|
||||
[discussions-image]: https://img.shields.io/badge/discussions-on%20github-blue?style=flat-square
|
||||
[discussions-url]: https://github.com/alibaba/lowcode-engine/discussions
|
||||
|
||||
[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
|
||||
|
||||
</div>
|
||||
|
||||
[](https://lowcode-engine.cn)
|
||||
|
||||
简体中文 | [English](./README.md)
|
||||
|
||||
## ✨ 特性
|
||||
|
||||
- 🌈 提炼自企业级低代码平台的面向扩展设计的内核引擎，奉行最小内核，最强生态的设计理念
|
||||
- 📦 开箱即用的高质量生态元素，包括 物料体系、设置器、插件 等
|
||||
- ⚙️ 完善的工具链，支持 物料体系、设置器、插件 等生态元素的全链路研发周期
|
||||
- 🔌 强大的扩展能力，已支撑近 100 个各种垂直类低代码平台
|
||||
- 🛡 使用 TypeScript 开发，提供完整的类型定义文件
|
||||
|
||||
## 🎯 兼容环境
|
||||
|
||||
- 现代浏览器（Chrome >= 80, Edge >= 80, last 2 safari versions, last 2 firefox versions）
|
||||
|
||||
## 📚 引擎协议
|
||||
|
||||
引擎完整实现了《阿里巴巴中后台前端基础搭建协议规范》和《阿里巴巴中后台前端物料协议规范》，协议栈是低代码领域的物料能否流通的关键部分。
|
||||
|
||||
|
||||
|
||||
## 🌰 使用示例
|
||||
|
||||
```bash
|
||||
npm install @alilc/lowcode-engine --save-dev
|
||||
```
|
||||
|
||||
> **TIPS：仅支持 cdn 方式引入，npm 包用于提供 typings 等代码提示能力**
|
||||
|
||||
```ts
|
||||
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'));
|
||||
```
|
||||
|
||||
### 工程化配置：
|
||||
```json
|
||||
{
|
||||
"externals": {
|
||||
"@alilc/lowcode-engine": "var window.AliLowCodeEngine",
|
||||
"@alilc/lowcode-engine-ext": "var window.AliLowCodeEngineExt"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### cdn 可选方式：
|
||||
#### 方式 1（推荐）：alifd cdn
|
||||
```html
|
||||
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
|
||||
```html
|
||||
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
|
||||
```html
|
||||
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 提供商
|
||||
|
||||
## 🔗 相关链接
|
||||
|
||||
- [官网首页](https://lowcode-engine.cn/)
|
||||
- [Demo 马上玩](https://lowcode-engine.cn/demo) | [引擎 Demo 仓库](https://github.com/alibaba/lowcode-demo)
|
||||
- [官方物料](https://github.com/alibaba/lowcode-materials)
|
||||
- [官方设置器（setter）](https://github.com/alibaba/lowcode-engine-ext)
|
||||
- [官方插件（plugin）](https://github.com/alibaba/lowcode-plugins)
|
||||
- [生态元素（物料、setter、插件）工具链](https://www.yuque.com/lce/doc/ulvlkz)
|
||||
- [用户文档](https://lowcode-engine.cn/doc)
|
||||
- [API [WIP]](https://lowcode-engine.cn/doc?url=vlmeme)
|
||||
|
||||
## 💻 本地调试
|
||||
|
||||
```bash
|
||||
$ git clone git@github.com:alibaba/lowcode-engine.git
|
||||
$ cd lowcode-engine
|
||||
$ npm install
|
||||
$ npm run setup
|
||||
$ npm start
|
||||
```
|
||||
|
||||
> 📢 npm 访问速度较慢，阿里员工可以使用 tnpm，其他同学建议使用 cnpm 或者指定镜像 registry。
|
||||
>
|
||||
> 📢 node 版本限定在 14
|
||||
>
|
||||
> 📢 windows 环境必须使用 [WSL](https://docs.microsoft.com/zh-cn/windows/wsl/install)，其他终端不保证能正常运行
|
||||
|
||||
lowcode-engine 启动后，提供了几个 umd 文件，可以结合 [lowcode-demo](https://github.com/alibaba/lowcode-demo) 项目做调试，文件代理规则参考[这里](https://www.yuque.com/lce/doc/glz0fx)。
|
||||
|
||||
## 🤝 参与共建
|
||||
|
||||
请先阅读：
|
||||
1. [如何配置引擎调试环境？](https://www.yuque.com/lce/doc/glz0fx)
|
||||
2. [关于引擎的研发协作流程](https://www.yuque.com/lce/doc/contributing)
|
||||
3. [引擎的工程化配置](https://www.yuque.com/lce/doc/gxwqg6)
|
||||
|
||||
> 强烈推荐阅读 [《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way)、[《如何向开源社区提问题》](https://github.com/seajs/seajs/issues/545) 和 [《如何有效地报告 Bug》](http://www.chiark.greenend.org.uk/%7Esgtatham/bugs-cn.html)、[《如何向开源项目提交无法解答的问题》](https://zhuanlan.zhihu.com/p/25795393)，更好的问题更容易获得帮助。（此段参考 [antd](https://github.com/ant-design/ant-design)）
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../README.md
|
||||
|
|
@ -0,0 +1,155 @@
|
|||
<p align="center">
|
||||
<a href="http://lowcode-engine.cn">
|
||||
<img width="200" src="https://img.alicdn.com/imgextra/i3/O1CN01i8K9cD1d0HU7TjDtv_!!6000000003673-2-tps-500-591.png">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
<h1 align="center">LowCodeEngine</h1>
|
||||
|
||||
<div align="center">
|
||||
|
||||
An enterprise-class low-code technology stack for scale-out design
|
||||
|
||||
[![NPM version][npm-image]][npm-url] [![NPM downloads][download-image]][download-url]
|
||||
|
||||
[![Discussions][discussions-image]][discussions-url] [![][issues-helper-image]][issues-helper-url] [![Issues need help][help-wanted-image]][help-wanted-url]
|
||||
|
||||
[npm-image]: https://img.shields.io/npm/v/@alilc/lowcode-engine.svg?style=flat-square
|
||||
[npm-url]: http://npmjs.org/package/@alilc/lowcode-engine
|
||||
|
||||
[download-image]: https://img.shields.io/npm/dm/@alilc/lowcode-engine.svg?style=flat-square
|
||||
[download-url]: https://npmjs.org/package/@alilc/lowcode-engine
|
||||
[help-wanted-image]: https://flat.badgen.net/github/label-issues/alibaba/lowcode-engine/help%20wanted/open
|
||||
[help-wanted-url]: https://github.com/alibaba/lowcode-engine/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22
|
||||
[discussions-image]: https://img.shields.io/badge/discussions-on%20github-blue?style=flat-square
|
||||
[discussions-url]: https://github.com/alibaba/lowcode-engine/discussions
|
||||
|
||||
[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
|
||||
|
||||
</div>
|
||||
|
||||
[](http://lowcode-engine.cn)
|
||||
|
||||
English | [简体中文](./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 "Alibaba Mid-Backend Front-End Basic Construction Protocol Specification" and "Alibaba Mid-Backend Front-End 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: YourFantaticLogo,
|
||||
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/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
|
||||
```
|
||||
|
||||
#### Method 2: unpkg
|
||||
```html
|
||||
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
|
||||
```
|
||||
|
||||
#### Method 3: jsdelivr
|
||||
```html
|
||||
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
|
||||
```
|
||||
|
||||
#### Method 4: Use your own cdn
|
||||
Pass the files under packages/engine/dist and packages/(react|rax)-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://www.yuque.com/lce/doc/ulvlkz)
|
||||
- [User Documentation](http://lowcode-engine.cn/doc)
|
||||
- [API [WIP]](http://lowcode-engine.cn/doc?url=vlmeme)
|
||||
|
||||
## 💻 Local debugging
|
||||
|
||||
```bash
|
||||
$ git clone git@github.com: 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.
|
||||
>
|
||||
> 📢 node version limited to 14
|
||||
>
|
||||
> 📢 Windows environment must use [WSL](https://docs.microsoft.com/zh-cn/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:/ /www.yuque.com/lce/doc/glz0fx).
|
||||
|
||||
## 🤝 Participate in co-construction
|
||||
|
||||
Please read first:
|
||||
1. [How to configure the engine debugging environment? ](https://www.yuque.com/lce/doc/glz0fx)
|
||||
2. [About the R&D collaboration process of the engine](https://www.yuque.com/lce/doc/contributing)
|
||||
3. [Engineering Configuration of Engine](https://www.yuque.com/lce/doc/gxwqg6)
|
||||
|
||||
> 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))
|
||||
Loading…
Reference in New Issue