README.md 8.23 KB
Newer Older
Loïc PIREZ's avatar
Loïc PIREZ committed
1
English | [简体中文](./README.zh-CN.md) | [Русский](./README.ru-RU.md) | [Türkçe](./README.tr-TR.md) | [日本語](./README.ja-JP.md) | [Français](./README.fr-FR.md)
偏右's avatar
偏右 committed
2

afc163's avatar
afc163 committed
3 4 5 6 7
<h1 align="center">Ant Design Pro</h1>

<div align="center">

An out-of-box UI solution for enterprise applications as a React boilerplate.
afc163's avatar
afc163 committed
8

陈帅's avatar
陈帅 committed
9 10 11
[![Build With Umi](https://img.shields.io/badge/build%20with-umi-028fe4.svg?style=flat-square)](http://umijs.org/) [![Build Status](https://dev.azure.com/ant-design/ant-design-pro/_apis/build/status/ant-design.ant-design-pro?branchName=master)](https://dev.azure.com/ant-design/ant-design-pro/_build/latest?definitionId=1?branchName=master) [![Dependencies](https://img.shields.io/david/ant-design/ant-design-pro.svg)](https://david-dm.org/ant-design/ant-design-pro) [![DevDependencies](https://img.shields.io/david/dev/ant-design/ant-design-pro.svg)](https://david-dm.org/ant-design/ant-design-pro?type=dev) [![Gitter](https://img.shields.io/gitter/room/ant-design/pro-english.svg?style=flat-square&logoWidth=20&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCjxzdmcgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgd2lkdGg9IjEyMzUiIGhlaWdodD0iNjUwIiB2aWV3Qm94PSIwIDAgNzQxMCAzOTAwIj4NCjxyZWN0IHdpZHRoPSI3NDEwIiBoZWlnaHQ9IjM5MDAiIGZpbGw9IiNiMjIyMzQiLz4NCjxwYXRoIGQ9Ik0wLDQ1MEg3NDEwbTAsNjAwSDBtMCw2MDBINzQxMG0wLDYwMEgwbTAsNjAwSDc0MTBtMCw2MDBIMCIgc3Ryb2tlPSIjZmZmIiBzdHJva2Utd2lkdGg9IjMwMCIvPg0KPHJlY3Qgd2lkdGg9IjI5NjQiIGhlaWdodD0iMjEwMCIgZmlsbD0iIzNjM2I2ZSIvPg0KPGcgZmlsbD0iI2ZmZiI%2BDQo8ZyBpZD0iczE4Ij4NCjxnIGlkPSJzOSI%2BDQo8ZyBpZD0iczUiPg0KPGcgaWQ9InM0Ij4NCjxwYXRoIGlkPSJzIiBkPSJNMjQ3LDkwIDMxNy41MzQyMzAsMzA3LjA4MjAzOSAxMzIuODczMjE4LDE3Mi45MTc5NjFIMzYxLjEyNjc4MkwxNzYuNDY1NzcwLDMwNy4wODIwMzl6Ii8%2BDQo8dXNlIHhsaW5rOmhyZWY9IiNzIiB5PSI0MjAiLz4NCjx1c2UgeGxpbms6aHJlZj0iI3MiIHk9Ijg0MCIvPg0KPHVzZSB4bGluazpocmVmPSIjcyIgeT0iMTI2MCIvPg0KPC9nPg0KPHVzZSB4bGluazpocmVmPSIjcyIgeT0iMTY4MCIvPg0KPC9nPg0KPHVzZSB4bGluazpocmVmPSIjczQiIHg9IjI0NyIgeT0iMjEwIi8%2BDQo8L2c%2BDQo8dXNlIHhsaW5rOmhyZWY9IiNzOSIgeD0iNDk0Ii8%2BDQo8L2c%2BDQo8dXNlIHhsaW5rOmhyZWY9IiNzMTgiIHg9Ijk4OCIvPg0KPHVzZSB4bGluazpocmVmPSIjczkiIHg9IjE5NzYiLz4NCjx1c2UgeGxpbms6aHJlZj0iI3M1IiB4PSIyNDcwIi8%2BDQo8L2c%2BDQo8L3N2Zz4%3D)](https://gitter.im/ant-design/pro-english?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [![Join the chat at https://gitter.im/ant-design/ant-design-pro](https://img.shields.io/gitter/room/ant-design/ant-design-pro.svg?style=flat-square&logoWidth=20&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCjxzdmcgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgd2lkdGg9IjkwMCIgaGVpZ2h0PSI2MDAiIHZpZXdCb3g9IjAgMCAzMCAyMCI%2BDQo8ZGVmcz4NCjxwYXRoIGlkPSJzIiBkPSJNMCwtMSAwLjU4Nzc4NSwwLjgwOTAxNyAtMC45NTEwNTcsLTAuMzA5MDE3SDAuOTUxMDU3TC0wLjU4Nzc4NSwwLjgwOTAxN3oiIGZpbGw9IiNmZmRlMDAiLz4NCjwvZGVmcz4NCjxyZWN0IHdpZHRoPSIzMCIgaGVpZ2h0PSIyMCIgZmlsbD0iI2RlMjkxMCIvPg0KPHVzZSB4bGluazpocmVmPSIjcyIgdHJhbnNmb3JtPSJ0cmFuc2xhdGUoNSw1KSBzY2FsZSgzKSIvPg0KPHVzZSB4bGluazpocmVmPSIjcyIgdHJhbnNmb3JtPSJ0cmFuc2xhdGUoMTAsMikgcm90YXRlKDIzLjAzNjI0MykiLz4NCjx1c2UgeGxpbms6aHJlZj0iI3MiIHRyYW5zZm9ybT0idHJhbnNsYXRlKDEyLDQpIHJvdGF0ZSg0NS44Njk4OTgpIi8%2BDQo8dXNlIHhsaW5rOmhyZWY9IiNzIiB0cmFuc2Zvcm09InRyYW5zbGF0ZSgxMiw3KSByb3RhdGUoNjkuOTQ1Mzk2KSIvPg0KPHVzZSB4bGluazpocmVmPSIjcyIgdHJhbnNmb3JtPSJ0cmFuc2xhdGUoMTAsOSkgcm90YXRlKDIwLjY1OTgwOCkiLz4NCjwvc3ZnPg%3D%3D)](https://gitter.im/ant-design/ant-design-pro?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [![Netlify Status](https://api.netlify.com/api/v1/badges/ee4b4cc9-f8d7-4542-929f-a025c5927663/deploy-status)](https://app.netlify.com/sites/angry-lumiere-4b8ba4/deploys) ![](https://badgen.net/badge/icon/Ant%20Design?icon=https://gw.alipayobjects.com/zos/antfincdn/Pp4WPgVDB3/KDpgvguMpGfqaHPjicRK.svg&label)

![](https://user-images.githubusercontent.com/8186664/44953195-581e3d80-aec4-11e8-8dcb-54b9db38ec11.png)
偏右's avatar
偏右 committed
12

afc163's avatar
afc163 committed
13 14
</div>

afc163's avatar
afc163 committed
15 16 17
- 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
18
- ChangeLog: http://pro.ant.design/docs/changelog
afc163's avatar
afc163 committed
19
- FAQ: http://pro.ant.design/docs/faq
ddcat1115's avatar
ddcat1115 committed
20
- Mirror Site in China: http://ant-design-pro.gitee.io
偏右's avatar
偏右 committed
21

陈帅's avatar
陈帅 committed
22
## 4.0 Released Now! 🎉🎉🎉
陈帅's avatar
陈帅 committed
23

陈帅's avatar
陈帅 committed
24
[Announcing Ant Design Pro 4.0.0](https://medium.com/ant-design/ant-design-pro-v4-is-here-6f23098ae9d9)
陈帅's avatar
陈帅 committed
25

偏右's avatar
偏右 committed
26 27 28 29
## Translation Recruitment :loudspeaker:

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

afc163's avatar
afc163 committed
30
## Features
偏右's avatar
偏右 committed
31

32 33
- :bulb: **TypeScript**: A language for application-scale JavaScript
- :scroll: **Blocks**: Build page with block template
偏右's avatar
偏右 committed
34
- :gem: **Neat Design**: Follow [Ant Design specification](http://ant.design/)
afc163's avatar
afc163 committed
35
- :triangular_ruler: **Common Templates**: Typical templates for enterprise applications
afc163's avatar
Add umi  
afc163 committed
36
- :rocket: **State of The Art Development**: Newest development stack of React/umi/dva/antd
Leonardo Farroco's avatar
Leonardo Farroco committed
37
- :iphone: **Responsive**: Designed for variable screen sizes
nestoralonso's avatar
nestoralonso committed
38
- :art: **Theming**: Customizable theme with simple config
afc163's avatar
afc163 committed
39
- :globe_with_meridians: **International**: Built-in i18n solution
Leonardo Farroco's avatar
Leonardo Farroco committed
40
- :gear: **Best Practices**: Solid workflow to make your code healthy
afc163's avatar
afc163 committed
41
- :1234: **Mock development**: Easy to use mock development solution
Leonardo Farroco's avatar
Leonardo Farroco committed
42
- :white_check_mark: **UI Test**: Fly safely with unit and e2e tests
偏右's avatar
偏右 committed
43

afc163's avatar
afc163 committed
44
## Templates
afc163's avatar
afc163 committed
45 46 47

```
- Dashboard
afc163's avatar
afc163 committed
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
afc163's avatar
afc163 committed
63 64 65
- Account
  - Account Center
  - Account Settings
afc163's avatar
afc163 committed
66 67 68 69 70 71 72 73 74 75 76
- Result
  - Success
  - Failed
- Exception
  - 403
  - 404
  - 500
- User
  - Login
  - Register
  - Register Result
afc163's avatar
afc163 committed
77 78
```

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

陈帅's avatar
陈帅 committed
81 82
### Use bash

afc163's avatar
afc163 committed
83
```bash
陈帅's avatar
陈帅 committed
84
$ yarn create umi  # or npm create umi
陈帅's avatar
陈帅 committed
85

陈帅's avatar
陈帅 committed
86 87 88 89 90 91 92
# Choose ant-design-pro:
 Select the boilerplate type (Use arrow keys)
❯ ant-design-pro  - Create project with an layout-only ant-design-pro boilerplate, use together with umi block.
  app             - Create project with a simple boilerplate, support typescript.
  block           - Create a umi block.
  library         - Create a library with umi.
  plugin          - Create a umi plugin.
陈帅's avatar
陈帅 committed
93

陈帅's avatar
陈帅 committed
94 95
$ npm install
$ npm start         # visit http://localhost:8000
陈帅's avatar
陈帅 committed
96 97
```

Sven Efftinge's avatar
Sven Efftinge committed
98 99 100 101 102 103
### Use Gitpod

Open the project in Gitpod (free online dev environment for GitHub) and start coding immediately.

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/ant-design/ant-design-pro)

Leonardo Farroco's avatar
Leonardo Farroco committed
104
More instructions at [documentation](http://pro.ant.design/docs/getting-started).
偏右's avatar
偏右 committed
105

afc163's avatar
afc163 committed
106
## Browsers support
afc163's avatar
afc163 committed
107

afc163's avatar
afc163 committed
108
Modern browsers and IE11.
afc163's avatar
afc163 committed
109

afc163's avatar
afc163 committed
110
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png" alt="Opera" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Opera |
陈帅's avatar
陈帅 committed
111 112
| --- | --- | --- | --- | --- |
| IE11, Edge | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
afc163's avatar
afc163 committed
113

afc163's avatar
afc163 committed
114
## Contributing
偏右's avatar
偏右 committed
115

Leonardo Farroco's avatar
Leonardo Farroco committed
116
Any type of contribution is welcome, here are some examples of how you may contribute to this project:
偏右's avatar
偏右 committed
117

afc163's avatar
afc163 committed
118
- Use Ant Design Pro in your daily work.
Leonardo Farroco's avatar
Leonardo Farroco committed
119 120
- Submit [issues](http://github.com/ant-design/ant-design-pro/issues) to report bugs or ask questions.
- Propose [pull requests](http://github.com/ant-design/ant-design-pro/pulls) to improve our code.
陈帅's avatar
陈帅 committed
121 122 123 124 125

<div align="center">
   <a href="https://www.netlify.com">
    <img src="https://www.netlify.com/img/global/badges/netlify-color-bg.svg"/>
  </a>
陈帅's avatar
陈帅 committed
126
</div>