Merge pull request #114 from idin-khayami/master

Add English Readme V.1
This commit is contained in:
liaoxuezhi 2019-07-17 14:06:42 +08:00 committed by GitHub
commit b68a6664ed

View File

@ -0,0 +1,59 @@
# amis
A page renderer that renders pages directly based on a JSON configuration in a specific format. Combined with the business-side API, you can quickly develop various management pages.
Currently used in Baidu's internal [AMIS] (http://amis.baidu.com) platform, 100+ departments have access to use, create 1.2w+ pages, welcome to use and make suggestions.
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
# Start compiling and output the code to the webroot directory of the service you just opened.
Npm run dev
# Open the fis3 service, please visit http://127.0.0.1:8888/examples/pages/simple.
Npm start
```
## Testing
```bash
#Installation dependency
Npm i
#Executing test cases
Npm test
# View test case coverage
Npm run coverage
```
## 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)
## 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)
## Discussion
Welcome to ISSUE for discussion.