amis2/README.md

75 lines
2.1 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>
2020-12-23 10:34:41 +08:00
2020-12-23 10:33:11 +08:00
[文档(国内)](https://baidu.gitee.io/amis/docs/index) |
[文档(国外)](https://baidu.github.io/amis/docs/index) |
[可视化编辑器](https://github.com/fex-team/amis-editor-demo) |
[amis-admin](https://github.com/fex-team/amis-admin) |
[爱速搭](https://suda.baidu.com/)
2020-12-23 10:34:41 +08:00
2020-12-23 10:33:11 +08:00
</div>
<div align="center">
2020-12-23 10:34:41 +08:00
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)
![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) 上的镜像。
推荐使用 node 8/10/12。
2019-09-23 13:15:05 +08:00
```bash
# 安装项目 npm 依赖,在 node 12 下会有报错但不影响正常使用。
2019-04-30 11:11:25 +08:00
npm i
# 开始编译,把代码产出到刚开启的服务的 webroot 目录。
2019-09-10 15:46:30 +08:00
# 这个程序不会自动结束,进入一个 watch 模式,文件变动会重新编译。
2019-04-30 11:11:25 +08:00
npm run dev
# 开启 fis3 服务,请通过 http://127.0.0.1:8888/examples/pages/simple 访问。
npm start
```
2019-09-23 13:15:05 +08:00
### 测试
2019-04-30 11:11:25 +08:00
```bash
# 安装依赖
2019-09-23 13:15:05 +08:00
npm i
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
```
2019-09-23 13:15:05 +08:00
### 如何贡献
2019-04-30 11:11:25 +08:00
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)
2019-04-30 11:11:25 +08:00
## 讨论
2020-08-06 19:20:47 +08:00
- Issues: https://github.com/baidu/amis/issues
2020-08-07 11:58:07 +08:00
- [如流](https://infoflow.baidu.com/)群3395342
2020-08-06 19:20:47 +08:00
- QQ 群: 1147750223