amis/README.md

94 lines
2.8 KiB
Markdown
Raw Normal View History

2020-12-23 10:33:11 +08:00
<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/) |
2022-01-07 12:25:40 +08:00
[文档(备用)](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) |
2021-08-27 11:23:46 +08:00
[爱速搭](https://baidu.gitee.io/aisuda-docs/)
2021-01-05 10:27:02 +08:00
</div>
<div align="center">
QQ 群: 1147750223已满 |
2020-12-30 13:51:36 +08:00
QQ 群2: 651547026 |
2021-10-12 18:59:46 +08:00
如流群3395342已满|
2021-11-03 15:32:59 +08:00
如流群25511067|
2020-12-23 10:33:11 +08:00
</div>
<div align="center">
2020-12-10 11:32:33 +08:00
![build](https://api.travis-ci.org/baidu/amis.svg?branch=master)
![license](https://img.shields.io/github/license/baidu/amis.svg)
![version](https://img.shields.io/npm/v/amis)
![language](https://img.shields.io/github/languages/top/baidu/amis)
2022-02-15 14:49:28 +08:00
[![codecov](https://codecov.io/gh/baidu/amis/branch/master/graph/badge.svg?token=9LwimHGoE5)](https://codecov.io/gh/baidu/amis)
2020-12-10 11:32:33 +08:00
![last](https://img.shields.io/github/last-commit/baidu/amis.svg)
2020-12-23 10:34:41 +08:00
2020-12-23 10:33:11 +08:00
</div>
2020-12-10 11:32:33 +08:00
前端低代码框架,通过 JSON 配置就能生成各种后台页面,极大减少开发成本,甚至可以不需要了解前端。
2019-04-30 11:11:25 +08:00
2019-09-23 13:15:05 +08:00
## 开发指南
2020-07-31 15:59:24 +08:00
以下是参与开发 amis 才需要看的,使用请看前面的文档。
2020-04-17 16:39:40 +08:00
> 如果 github 下载慢可以使用 [gitee](https://gitee.com/baidu/amis) 上的镜像。
2021-04-21 18:19:55 +08:00
推荐使用 node 12/14。
2019-09-23 13:15:05 +08:00
```bash
# 安装项目 npm 依赖,在 node 12 下会有报错但不影响正常使用。
npm i --legacy-peer-deps
2019-04-30 11:11:25 +08:00
# 启动项目,等编译结束后通过 http://127.0.0.1:8888/examples/pages/simple 访问。
2019-04-30 11:11:25 +08:00
npm start
```
2019-09-23 13:15:05 +08:00
### 测试
2019-04-30 11:11:25 +08:00
```bash
# 安装依赖
npm i --legacy-peer-deps
2019-04-30 11:11:25 +08:00
2019-06-19 10:05:07 +08:00
# 执行测试用例
2019-04-30 11:11:25 +08:00
npm test
2019-06-19 10:05:07 +08:00
# 查看测试用例覆盖率
2019-04-30 11:11:25 +08:00
npm run coverage
# 更新 snapshot
npm run update-snapshot
2019-04-30 11:11:25 +08:00
```
2019-09-23 13:15:05 +08:00
### 如何贡献
2019-04-30 11:11:25 +08:00
2021-04-13 13:20:57 +08:00
请使用分支开发,首先创建分支
git checkout -b feat-xxx
2021-04-13 13:20:57 +08:00
开发提交后使用 `git push --set-upstream origin feat-xxx` 创建远程分支。
然后通过系统提示的 https://github.com/xxx/amis/pull/new/feat-xxx 链接来提交 PR。
2019-06-13 15:22:34 +08:00
请采用 typescript 编写,所有合理的改动、新的公用渲染器、用例或者文档的提交都会被接收。
2019-04-30 11:11:25 +08:00
## 维护者
2020-04-17 16:39:40 +08:00
- [2betop](https://github.com/2betop)
- [RickCole21](https://github.com/RickCole21)
- [catchonme](https://github.com/catchonme)
- [nwind](https://github.com/nwind)
2021-12-10 17:51:46 +08:00
- [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)
2021-04-27 11:43:14 +08:00
## 低代码平台
2021-08-27 11:23:46 +08:00
amis 只能实现前端低代码,如果需要完整的低代码平台推荐使用[爱速搭](https://baidu.gitee.io/aisuda-docs/)。