README.md 2.85 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

偏右's avatar
偏右 committed
5
[![](https://img.shields.io/travis/ant-design/ant-design-pro/master.svg?style=flat-square)](https://travis-ci.org/ant-design/ant-design-pro) [![Build status](https://ci.appveyor.com/api/projects/status/67fxu2by3ibvqtat/branch/master?svg=true)](https://ci.appveyor.com/project/afc163/ant-design-pro/branch/master)  [![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

偏右's avatar
偏右 committed
7
An out-of-box UI solution for enterprise applications as a React boilerplate.
偏右'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
- Preview: http://preview.pro.ant.design
- Home Page: http://pro.ant.design
- Documentation: http://pro.ant.design/docs/getting-started
afc163's avatar
afc163 committed
14
- ChangeLog: http://pro.ant.design/docs/changelog
afc163's avatar
afc163 committed
15
- FAQ: http://pro.ant.design/docs/faq
偏右's avatar
偏右 committed
16

偏右's avatar
偏右 committed
17 18 19 20
## Translation Recruitment :loudspeaker:

We need your help: https://github.com/ant-design/ant-design-pro/issues/120

afc163's avatar
afc163 committed
21
## Features
偏右's avatar
偏右 committed
22

偏右's avatar
偏右 committed
23
- :gem: **Neat Design**: Follow [Ant Design specification](http://ant.design/)
afc163's avatar
afc163 committed
24 25 26
- :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
nestoralonso's avatar
nestoralonso committed
27
- :art: **Theming**: Customizable theme with simple config
afc163's avatar
afc163 committed
28 29 30 31
- :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
32

afc163's avatar
afc163 committed
33
## Templates
afc163's avatar
afc163 committed
34 35 36

```
- Dashboard
afc163's avatar
afc163 committed
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
  - 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
63 64
```

afc163's avatar
afc163 committed
65
## Usage
afc163's avatar
afc163 committed
66

afc163's avatar
afc163 committed
67
```bash
Jeff Wen's avatar
Jeff Wen committed
68
$ git clone https://github.com/ant-design/ant-design-pro.git --depth=1
偏右's avatar
偏右 committed
69
$ cd ant-design-pro
afc163's avatar
afc163 committed
70
$ npm install
afc163's avatar
afc163 committed
71
$ npm start         # visit http://localhost:8000
afc163's avatar
afc163 committed
72 73
```

afc163's avatar
afc163 committed
74
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
75 76 77 78

```bash
$ npm install ant-design-pro-cli -g
$ mkdir pro-demo && cd pro-demo
nikogu's avatar
nikogu committed
79
$ pro new
afc163's avatar
afc163 committed
80
```
niko's avatar
niko committed
81

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

afc163's avatar
afc163 committed
84
## Compatibility
afc163's avatar
afc163 committed
85

afc163's avatar
afc163 committed
86
Modern browsers and IE11.
afc163's avatar
afc163 committed
87

afc163's avatar
afc163 committed
88
## Contributing
偏右's avatar
偏右 committed
89

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

afc163's avatar
afc163 committed
92 93 94
- 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.