amis/README-en.md

60 lines
1.5 KiB
Markdown
Raw Permalink Normal View History

2019-07-17 13:41:28 +08:00
# amis
A Low-Code frontend UI Framework. You can quickly develop various management pages by only using JSON configuration. Frontend skill is not required.
2019-07-17 13:41:28 +08:00
Currently used in Baidu's internal infrastructure, created more than 40000 pages.
2019-07-17 13:41:28 +08:00
To build your own backend system with amis, you can refer to this: https://github.com/fex-team/amis-admin
## Quick start
```
# Install project npm dependencies.
npm i
2019-07-17 13:41:28 +08:00
# Start compiling and output the code to the webroot directory of the service you just opened.
npm run dev
2019-07-17 13:41:28 +08:00
# Open the fis3 service, please visit http://127.0.0.1:8888/examples/pages/simple.
npm start
2019-07-17 13:41:28 +08:00
```
## Testing
```bash
#Installation dependency
npm i
2019-07-17 13:41:28 +08:00
#Executing test cases
npm test
2019-07-17 13:41:28 +08:00
# View test case coverage
npm run coverage
2019-07-17 13:41:28 +08:00
```
## Working with documents
For a better reading experience, it is recommended to read https://baidu.github.io/amis/ directly in gh-pages.
- [Quick Start](/docs/getting_started.md)
- [Basic Usage](/docs/basic.md)
- [Advanced Usage](/docs/advanced.md)
- [Render Manual](/docs/renderers.md)
- [How to customize](/docs/sdk.md)
- [custom component](/docs/dev.md)
- [Auxiliary Style](/docs/style.md)
2019-07-17 13:41:28 +08:00
## How to contribute
Please write in typescript, all reasonable changes, new public renderers, use cases, or document submissions will be received.
## Maintainer
- [2betop](https://github.com/2betop)
- [RickCole21](https://github.com/RickCole21)
- [catchonme](https://github.com/catchonme)
2019-07-17 13:41:28 +08:00
## Discussion
Welcome to ISSUE for discussion.