mirror of https://github.com/smartxworks/sunmao-ui.git synced 2024-11-21 03:15:49 +08:00

Go to file

Bowen Tan 158c462a95 fix(validator): add expression keywords list		2022-07-13 17:42:44 +08:00
.github	chore(ci): add ci to develop branch	2022-06-22 17:14:11 +08:00
.husky	chore: add commit lint and script	2022-05-23 15:48:47 +08:00
assets
config	test(runtime): add async merge state test	2022-06-21 10:46:29 +08:00
docs	chore(*): replace MIT with apache 2.0	2022-07-11 16:34:18 +08:00
examples	refactor(runtime): fix eslint	2022-06-21 11:17:46 +08:00
packages	fix(validator): add expression keywords list	2022-07-13 17:42:44 +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
LICENSE	update LICENSE to Apache 2.0	2022-06-13 13:47:59 +08:00
NOTICE.md	chore(*): add NOTICE.md	2022-07-11 14:25:10 +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	chore(*): replace MIT with apache 2.0	2022-07-11 16:34:18 +08:00
tsconfig.json
yarn.lock	Merge branch 'develop' of github.com:webzard-io/sunmao-ui into feat/module-spec	2022-07-07 11:09:05 +08:00

README.md

Sunmao

Apache-2.0 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?

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.

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.

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.

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.

For more details, read Sunmao: A truly extensible low-code UI framework.

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

Apache-2.0