amis README

The project's README from github.com/baidu/amis. As one markdown file: README.md.

文档（国内） | 文档（国外） | 可视化编辑器 | amis-admin | 爱速搭

如流群：3395342 | 如流群2：5511067|

build license version language codecov last

前端低代码框架，通过 JSON 配置就能生成各种后台页面，极大减少开发成本，甚至可以不需要了解前端。

开发指南

以下是参与开发 amis 才需要看的，使用请看前面的文档。

如果 github 下载慢可以使用 gitee 上的镜像。

推荐使用 node 12/14/16。npm 7+， 因为用到了 workspaces 功能。

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

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

如果是开发编辑器，需要访问 http://127.0.0.1:8888/packages/amis-editor/

测试

注意：本地修改代码后，执行测试用例（npm test --workspaces）之前需要先执行npm run build完成编译，因为 jest 并不支持 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>

发布版本

# 发布内部 registry
npm run publish

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

如何贡献

请使用分支开发，首先创建分支

git checkout -b feat-xxx

开发提交后使用 git push --set-upstream origin feat-xxx 创建远程分支。

然后通过系统提示的 https://github.com/xxx/amis/pull/new/feat-xxx 链接来提交 PR。

请采用 typescript 编写，所有合理的改动、新的公用渲染器、用例或者文档的提交都会被接收。

贡献者

低代码平台

amis 只能实现前端低代码，如果需要完整的低代码平台推荐使用爱速搭。

amis (baidu/amis)

Searching Database…

18.9K ·GitHub
Amis
这是什么？amis 是百度开源的前端低代码框架：你把后台管理页面写成 JSON 配置，框架就能帮你把它渲染出来。
那它是一个用来开发的框架，还是一个拿来就能运行的成品应用？是一个框架——你要把它引入自己的前端项目，页面由 JSON 配置生成。README 里还链接了一个现成的后台管理应用（amis-admin），以及一个围绕这个框架搭建的可视化编辑器。
我该怎么把它装进我的项目？它是一个 npm 包，接入标准的前端构建流程；使用文档（分国内版和国际版）的链接在 README 顶部。如果你想修改 amis 本身的源码，因为它采用 workspaces 的 monorepo 结构，需要 Node 12/14/16 和 npm 7 以上版本。
有什么它管不了的吗——我还是得自己写后端吗？是的——amis 只负责前端这一侧。如果你想要一个带后端的完整低代码平台，README 建议你改用百度的 Aisuda（爱速搭）。
它是给谁用的——我必须是前端开发人员才能用吗？它面向所有做后台页面的人：README 声称能省下很多开发成本，以至于你甚至可能完全不需要懂前端。不过，如果要参与贡献代码，就要求用 TypeScript 来写。
README 基本上都是中文的——有英文文档吗？有——页面顶部同时链接了国内版和国际版的文档。不过社区聊天用的是中文的如流（Ruliu）群。
每个页面的 JSON 都得我自己手写吗？不用——这个项目链接了一个可视化编辑器，不用手写配置就能拼出页面；amis-admin 则是一个基于该框架做好的现成后台应用。
它能生成哪些类型的页面？各种各样的后台管理页面——它的卖点就是各类管理页面都能直接从 JSON 配置生成，所以这个仓库也打了后台面板和低代码开发这两个标签。
amis 成熟吗？它从 2019 年 4 月起就在百度的 GitHub 组织下公开开发，目前大约有 1.89 万颗星，而且每次提交 pull request 都会跑 CI，包括 CodeQL 安全分析。
What are similar projects?refine, react-admin, illa-builder, ngx-admin, lowcode-engine, blur-admin, coreui-free-bootstrap-admin-template, ToolJet
Which topics is it in?baidu, declarative-ui, lowcode, admin-ui, admin, low-code, no-code, frontend-framework, admin-dashboard, json, ui, framework
Creator
baidu
Size
187.9 MB
Stars
18.9K
Updated
CommitMar 18Release6.13.0Aug 12
Age
7y
Commits · 90 Days