mirror of
https://gitee.com/baidu/amis.git
synced 2024-11-30 02:58:05 +08:00
94 lines
2.8 KiB
Markdown
94 lines
2.8 KiB
Markdown
<div align="center">
|
||
<p>
|
||
<img width="284" src="https://github.com/baidu/amis/raw/master/examples/static/logo.png">
|
||
</p>
|
||
|
||
[文档（国内）](https://baidu.gitee.io/amis/) |
|
||
[文档（备用）](https://aisuda.bce.baidu.com/amis/) |
|
||
[文档（国外）](https://baidu.github.io/amis/) |
|
||
[可视化编辑器](https://aisuda.github.io/amis-editor-demo/) |
|
||
[amis-admin](https://github.com/aisuda/amis-admin) |
|
||
[爱速搭](https://baidu.gitee.io/aisuda-docs/)
|
||
|
||
</div>
|
||
|
||
<div align="center">
|
||
QQ 群: 1147750223（已满） |
|
||
QQ 群2: 651547026 |
|
||
如流群：3395342（已满）|
|
||
如流群2：5511067|
|
||
</div>
|
||
|
||
<div align="center">
|
||
|
||
|
||
|
||
|
||
|
||
[](https://codecov.io/gh/baidu/amis)
|
||
|
||
|
||
</div>
|
||
|
||
前端低代码框架，通过 JSON 配置就能生成各种后台页面，极大减少开发成本，甚至可以不需要了解前端。
|
||
|
||
## 开发指南
|
||
|
||
以下是参与开发 amis 才需要看的，使用请看前面的文档。
|
||
|
||
> 如果 github 下载慢可以使用 [gitee](https://gitee.com/baidu/amis) 上的镜像。
|
||
|
||
推荐使用 node 12/14。
|
||
|
||
```bash
|
||
# 安装项目 npm 依赖，在 node 12 下会有报错但不影响正常使用。
|
||
npm i --legacy-peer-deps
|
||
|
||
# 启动项目，等编译结束后通过 http://127.0.0.1:8888/examples/pages/simple 访问。
|
||
npm start
|
||
```
|
||
|
||
### 测试
|
||
|
||
```bash
|
||
# 安装依赖
|
||
npm i --legacy-peer-deps
|
||
|
||
# 执行测试用例
|
||
npm test
|
||
|
||
# 查看测试用例覆盖率
|
||
npm run coverage
|
||
|
||
# 更新 snapshot
|
||
npm run update-snapshot
|
||
```
|
||
|
||
### 如何贡献
|
||
|
||
请使用分支开发，首先创建分支
|
||
|
||
git checkout -b feat-xxx
|
||
|
||
开发提交后使用 `git push --set-upstream origin feat-xxx` 创建远程分支。
|
||
|
||
然后通过系统提示的 https://github.com/xxx/amis/pull/new/feat-xxx 链接来提交 PR。
|
||
|
||
请采用 typescript 编写，所有合理的改动、新的公用渲染器、用例或者文档的提交都会被接收。
|
||
|
||
## 维护者
|
||
|
||
- [2betop](https://github.com/2betop)
|
||
- [RickCole21](https://github.com/RickCole21)
|
||
- [catchonme](https://github.com/catchonme)
|
||
- [nwind](https://github.com/nwind)
|
||
- [zhangtao07](https://github.com/zhangtao07)
|
||
- [hsm-lv](https://github.com/hsm-lv)
|
||
- [RUNZE LU](https://github.com/lurunze1226)
|
||
- [ucasliyuan](https://github.com/ucasliyuan)
|
||
- [yangwei9012](https://github.com/yangwei9012)
|
||
|
||
## 低代码平台
|
||
|
||
amis 只能实现前端低代码，如果需要完整的低代码平台推荐使用[爱速搭](https://baidu.gitee.io/aisuda-docs/)。
|