README.md 2.46 KB
Newer Older
afc163's avatar
afc163 committed
1
English | [简体中文](./README.zh-CN.md)
偏右's avatar
偏右 committed
2 3

# Ant Design Pro
afc163's avatar
afc163 committed
4

afc163's avatar
afc163 committed
5
[![](https://img.shields.io/travis/ant-design/ant-design-pro.svg?style=flat-square)](https://travis-ci.org/ant-design/ant-design-pro) [![Gitter](https://badges.gitter.im/ant-design/ant-design-pro.svg)](https://gitter.im/ant-design/ant-design-pro?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
afc163's avatar
afc163 committed
6

afc163's avatar
afc163 committed
7
An out-of-box UI solution for enterprise applications.
偏右's avatar
偏右 committed
8

afc163's avatar
update  
afc163 committed
9
![](https://gw.alipayobjects.com/zos/rmsportal/xEdBqwSzvoSapmnSnYjU.png)
偏右's avatar
偏右 committed
10

afc163's avatar
afc163 committed
11 12 13 14
- Preview: http://preview.pro.ant.design
- Home Page: http://pro.ant.design
- Documentation: http://pro.ant.design/docs/getting-started
- FAQ: http://pro.ant.design/docs/faq
偏右's avatar
偏右 committed
15

afc163's avatar
afc163 committed
16
## Features
偏右's avatar
偏右 committed
17

afc163's avatar
afc163 committed
18 19 20 21 22 23 24 25 26
- :gem: **Neat Design**: Follow Ant Design specification
- :triangular_ruler: **Common Templates**: Typical templates for enterprise applications
- :rocket: **State of The Art Development**: Newest development stack of React/dva/antd
- :iphone: **Responsive**: Designed for varies of screen size
- :art: **Themeing**: Customizable theme with simple config
- :globe_with_meridians: **International**: Built-in i18n solution
- :gear: **Best Practice**: Solid workflow make your code health
- :1234: **Mock development**: Easy to use mock development solution
- :white_check_mark: **UI Test**: Fly safely with unit test and e2e test
偏右's avatar
偏右 committed
27

afc163's avatar
afc163 committed
28
## Templates
afc163's avatar
afc163 committed
29 30 31

```
- Dashboard
afc163's avatar
afc163 committed
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
  - Analytic
  - Monitor
  - Workspace
- Form
  - Basic Form
  - Step Form
  - Advanced From
- List
  - Standard Table
  - Standard List
  - Card List
  - Search List (Project/Applications/Article)
- Profile
  - Simple Profile
  - Advanced Profile
- Result
  - Success
  - Failed
- Exception
  - 403
  - 404
  - 500
- User
  - Login
  - Register
  - Register Result
afc163's avatar
afc163 committed
58 59
```

afc163's avatar
afc163 committed
60
## Usage
afc163's avatar
afc163 committed
61

afc163's avatar
afc163 committed
62
```bash
afc163's avatar
afc163 committed
63
$ git clone git@github.com:ant-design/ant-design-pro --depth=1
偏右's avatar
偏右 committed
64
$ cd ant-design-pro
afc163's avatar
afc163 committed
65
$ npm install
afc163's avatar
afc163 committed
66
$ npm start         # visit http://localhost:8000
afc163's avatar
afc163 committed
67 68
```

afc163's avatar
afc163 committed
69
Or you can use the command tool: [ant-design-pro-cli](https://github.com/ant-design/ant-design-pro-cli)
afc163's avatar
afc163 committed
70 71 72 73 74 75

```bash
$ npm install ant-design-pro-cli -g
$ mkdir pro-demo && cd pro-demo
$ pro init
```
niko's avatar
niko committed
76

afc163's avatar
afc163 committed
77
More instruction at [documentation](http://pro.ant.design/docs/getting-started)
偏右's avatar
偏右 committed
78

afc163's avatar
afc163 committed
79
## Compatibility
afc163's avatar
afc163 committed
80

afc163's avatar
afc163 committed
81
Modern browsers and IE11.
afc163's avatar
afc163 committed
82

afc163's avatar
afc163 committed
83
## Contributing
偏右's avatar
偏右 committed
84

afc163's avatar
afc163 committed
85
Any Contribution of following ways will be welcome:
偏右's avatar
偏右 committed
86

afc163's avatar
afc163 committed
87 88 89
- Use Ant Design Pro in your daily work.
- Submit [issue](http://github.com/ant-design/ant-design-pro/issues) to report bug or ask questions.
- Propose [pull request](http://github.com/ant-design/ant-design-pro/pulls) to improve our code.