README.md 2.9 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
ddcat1115's avatar
ddcat1115 committed
16
- Mirror Site in China: http://ant-design-pro.gitee.io
偏右's avatar
偏右 committed
17

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

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

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

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

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

```
- Dashboard
afc163's avatar
afc163 committed
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 63
  - 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
64 65
```

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

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

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

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

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

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

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

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

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

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