mirror/sunmao-ui
2
0
Fork 0
mirror of https://github.com/smartxworks/sunmao-ui.git synced 2025-02-17 17:40:31 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(*): add architecture folder

Browse Source
This commit is contained in:
Bowen Tan 2022-07-11 14:48:30 +08:00
parent 3e0bdf64a6
commit 1d4e286e59
3 changed files with 17 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -18,7 +18,7 @@ Sunmao is a front-end low-code framework. Through Sunmao, you can easily encapsu
## Why Sunmao?
### Responsive low-code framework
### Reactive low-code framework
Sunmao chooses a responsive solution that is easy to understand and has excellent performance, making Sunmao intuitive and quick to use.
@ -26,7 +26,7 @@ Sunmao chooses a responsive solution that is easy to understand and has excellen
Sunmao has a built-in GUI editor, which almost includes all the capabilities that a complete low-code editor should have.
### Strong extensibility
### Extremely Extensible
Both the UI component library itself and the low-code editor support custom extensions. Developers can register various components to cover application requirements and continue to use the existing visual design system.
@ -36,22 +36,6 @@ You are in type safety both when developing Sunmao components and when using the
For more details, read [Sunmao: A truly extensible low-code UI framework](./docs/en/what-is-sunmao.md).
## Directory Structure
Sunmao is a monorepo project that includes the following packages:
| Name | Description |
| ------------- | ------------------------------------------------------------------------------------------- |
| core | Spec type definition of Sunmao |
| runtime | Sunmao's runtime |
| editor | Sunmao's GUI editor |
| editor-sdk | sdk for Sunmao Editor |
| shared | Types and utility functions shared by each package of the Sunmao project |
| chakra-ui-lib | [chakra-ui](https://chakra-ui.com/) component library packaged by Sunmao |
| arco-lib | [arco-design](https://arco.design/) component library packaged by Sunmao (recommend to use) |
![depend-graph](./docs/images/dependGraph.png)
## local development
### Start

15
docs/architecture/directoryStructure.md Normal file
View File

@ -0,0 +1,15 @@
# Directory Structure
Sunmao is a monorepo project that includes the following packages:
| Name | Description |
| ------------- | ------------------------------------------------------------------------------------------- |
| core | Spec type definition of Sunmao |
| runtime | Sunmao's runtime |
| editor | Sunmao's GUI editor |
| editor-sdk | sdk for Sunmao Editor |
| shared | Types and utility functions shared by each package of the Sunmao project |
| chakra-ui-lib | [chakra-ui](https://chakra-ui.com/) component library packaged by Sunmao |
| arco-lib | [arco-design](https://arco.design/) component library packaged by Sunmao (recommend to use) |
![depend-graph](../images/dependGraph.png)

16
docs/zh/README.md
View File

@ -35,22 +35,6 @@ Sunmao 内置了低代码工具的 GUI 编辑器，几乎囊括了一个完整
更多详情，请见 [Sunmao：一个真正可扩展的低代码 UI 框架](./what-is-sunmao.md)
## 目录结构
Sunmao 是一个 monorepo 项目，其中分别包含下面这些包：
| 名称 | 说明 |
| ------------- | -------------------------------------------------------------------- |
| core | Sunmao 的 Spec 类型定义 |
| runtime | Sunmao 的运行时 |
| editor | Sunmao 的 GUI 编辑器 |
| editor-sdk | Sunmao Editor 的 sdk |
| shared | Sunmao 项目各个包共用的类型和工具函数 |
| chakra-ui-lib | Sunmao 封装的 [chakra-ui](https://chakra-ui.com/) 组件库 |
| arco-lib | Sunmao 封装的 [arco-design](https://arco.design/) 组件库（推荐使用） |
![depend-graph](../images/dependGraph.png)
## 本地开发
### 启动项目