amis

Documentation (domestic) | Documentation (overseas) | Visual editor | amis-admin | Aisuda

Ruliu Group: 3395342 | Ruliu Group 2: 5511067|

The front-end low-code framework can generate various back-end pages through JSON configuration, greatly reducing development costs and even eliminating the need to understand the front-end.

Development Guide

The following is required for those who participate in the development of amis. Please refer to the previous documents for use.

If downloading from github is slow, you can use the mirror on gitee.

It is recommended to use node 12/14/16. npm 7+, because of the use of workspaces function.

 # 安装项目 npm 依赖，在 node 12 下会有报错但不影响正常使用。
npm i --legacy-peer-deps

# 启动项目，等编译结束后通过 http://127.0.0.1:8888/examples/pages/simple 访问。
npm start

If you are developing an editor, you need to visit http://127.0.0.1:8888/packages/amis-editor/

test

Note: After modifying the code locally, you need to execute npm run build to complete the compilation before executing the test case ( npm test --workspaces ), because jest does not support TypeScript.

 # 安装依赖
npm i --legacy-peer-deps

# 执行构建
npm run build

# 执行测试用例
npm test --workspaces

# 测试某个用例
# <spec-name>为用例名称，比如inputImage
npm test --workspace amis -- -t < spec-name >

# 运行某个单测文件
./node_modules/.bin/jest packages/amis/__tests__/renderers/Form/buttonToolBar.test.tsx

# 运行某个单测文件里的某个例子
./node_modules/.bin/jest packages/amis/__tests__/renderers/Form/buttonToolBar.test.tsx -t ' Renderer:button-toolbar '

# 查看测试用例覆盖率
npm run coverage

# 更新 snapshot
npm run update-snapshot

# 更新单个 snapshot
# <spec-name>为用例名称，比如inputImage
npm run update-snapshot --workspace amis -- -t  < spec-name >

release version

 # 发布内部 registry
npm run publish

# 发布外网环境
# 先通过一下命令设置版本号
npm run version
npm run release

How to contribute

Please use branch development and create a branch first

 git checkout -b feat-xxx

After development is submitted, use git push --set-upstream origin feat-xxx to create a remote branch.

Then submit the PR through the https://github.com/xxx/amis/pull/new/feat-xxx link prompted by the system.

Please write in typescript, all reasonable changes, new public renderers, use cases or documentation submissions will be accepted.

Contributor

low code platform

amis can only implement front-end low-code. If you need a complete low-code platform, it is recommended to use Aisuda.