amis/docs/languages/english
idin.khayami f6438ad0d4 Add English Readme V.1 2019-07-17 10:11:28 +04:30
..
README.md Add English Readme V.1 2019-07-17 10:11:28 +04:30

README.md

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

#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

Discussion

Welcome to ISSUE for discussion.