Go to file
2022-06-23 17:36:13 +08:00
.github remove code coverage report 2022-03-01 10:04:07 +08:00
.husky chore: add commit lint and script 2022-05-23 15:48:47 +08:00
assets init spec v0.1.0 2021-06-16 13:30:04 +08:00
config feat: add @sunmao-ui/shared 2022-04-25 16:15:46 +08:00
docs fix a broken link in README 2022-06-12 22:58:33 +10:00
examples feat(runtime): remove react-grid-layout 2022-06-20 18:30:30 +08:00
packages chore(shared): move shallowCompare to object.ts 2022-06-23 17:36:13 +08:00
spec/zh_CN refactor runtime variables to sunmao 2021-11-21 14:42:50 +08:00
.cz-config.js perf(ImplWrapper): use shallowCompare to compare slotProps 2022-06-22 17:08:51 +08:00
.czrc chore: add commit lint and script 2022-05-23 15:48:47 +08:00
.eslintrc.json extend metadata and set category annotation to core components 2022-02-09 12:50:51 +08:00
.gitignore use tsup to bundle core and runtime packages 2021-10-27 11:45:19 +08:00
.prettierrc introduce CodeMirror to implement code editors 2021-10-19 00:14:44 +08:00
commitlint.config.js chore: add commit lint and script 2022-05-23 15:48:47 +08:00
lerna.json impl plain button, text and app 2021-07-05 14:49:45 +08:00
LICENSE update LICENSE to Apache 2.0 2022-06-13 13:47:59 +08:00
package.json build(package.json): modify commit message to pass commitlint when releasing package 2022-06-06 15:50:31 +08:00
README.md docs(component): add docs and readme 2022-06-10 14:06:00 +08:00
tsconfig.json init core package 2021-07-02 16:06:02 +08:00
yarn.lock feat(runtime): remove react-grid-layout 2022-06-20 18:30:30 +08:00

logo

Sunmao-UI

MIT License GitHub issues Github Stars

Sunmao is a front-end low-code framework. Through Sunmao, you can easily encapsulate any front-end UI components into low-code component libraries, so as to build your own low-code UI development platform, making front-end development as tight as Sunmao.

中文

Why Sunmao?

Responsive low-code framework

Sunmao chooses a responsive solution that is easy to understand and has excellent performance, making Sunmao intuitive and quick to use.

Powerful low-code GUI editor

Sunmao has a built-in GUI editor, which almost includes all the capabilities that a complete low-code editor should have.

Strong extensibility

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.

Type Safety

You are in type safety both when developing Sunmao components and when using the Sunmao editor. Sunmao heavily uses Typescript and JSON schema for a great type system.

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 component library packaged by Sunmao
arco-lib arco-design component library packaged by Sunmao (recommend to use)

depend-graph

local development

Start

yarn
cd packages/editor
yarn dev

Test

yarn test:ci

Build

yarn

When you run the runtime or editor locally, if you modify the code of other packages, you must rebuild the modified package, otherwise, the runtime and editor will still run the old code.

Tutorial

Sunmao users are divided into two roles, one is a developer and the other is a user.

The responsibilities of developers are similar to those of common front-end developers. They are responsible for developing UI components and encapsulating common UI components to Sunmao components. Developers need to write code to implement the logic of the component.

The user's responsibility is to use the Sunmao components encapsulated by developers to build front-end applications in the Sunmao low-code editor. Users do not need front-end knowledge and programming skills. They can complete application construction only through UI interaction.

We have prepared two tutorials for different roles. The user only needs to read the user's tutorial, but the developer has to read both.

Online Demo

Sunmao Playground

License

MIT