README.md 5.29 KB
Newer Older
afc163's avatar
afc163 committed
1
English | [简体中文](./README.zh-CN.md) | [Русский](./README.ru-RU.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
[![CircleCI Status](https://circleci.com/gh/ant-design/ant-design-pro.svg?style=svg)](https://circleci.com/gh/ant-design/ant-design-pro/)
afc163's avatar
afc163 committed
10 11
[![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)
[![Dependencies](https://img.shields.io/david/ant-design/ant-design-pro.svg)](https://david-dm.org/ant-design/ant-design-pro)
afc163's avatar
afc163 committed
12
[![DevDependencies](https://img.shields.io/david/dev/ant-design/ant-design-pro.svg)](https://david-dm.org/ant-design/ant-design-pro?type=dev)
偏右's avatar
偏右 committed
13 14
[![Gitter](https://img.shields.io/gitter/room/ant-design/pro-english.svg)](https://gitter.im/ant-design/pro-english?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)(🇺🇸)
[![Gitter](https://img.shields.io/gitter/room/ant-design/ant-design-pro.svg?style=flat-square)](https://gitter.im/ant-design/ant-design-pro?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)(🇨🇳)
15

afc163's avatar
afc163 committed
16

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

afc163's avatar
afc163 committed
19 20
</div>

afc163's avatar
afc163 committed
21 22 23
- 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
24
- ChangeLog: http://pro.ant.design/docs/changelog
afc163's avatar
afc163 committed
25
- FAQ: http://pro.ant.design/docs/faq
ddcat1115's avatar
ddcat1115 committed
26
- Mirror Site in China: http://ant-design-pro.gitee.io
偏右's avatar
偏右 committed
27

陈帅's avatar
陈帅 committed
28 29 30
## 2.0 Released Now! 🎉🎉🎉
[Announcing Ant Design Pro 2.0.0](https://medium.com/ant-design/beautiful-and-powerful-ant-design-pro-2-0-release-51358da5af95)

偏右's avatar
偏右 committed
31 32 33 34
## Translation Recruitment :loudspeaker:

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

afc163's avatar
afc163 committed
35
## Features
偏右's avatar
偏右 committed
36

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

afc163's avatar
afc163 committed
47
## Templates
afc163's avatar
afc163 committed
48 49 50

```
- Dashboard
afc163's avatar
afc163 committed
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
  - 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
66 67 68
- Account
  - Account Center
  - Account Settings
afc163's avatar
afc163 committed
69 70 71 72 73 74 75 76 77 78 79
- Result
  - Success
  - Failed
- Exception
  - 403
  - 404
  - 500
- User
  - Login
  - Register
  - Register Result
afc163's avatar
afc163 committed
80 81
```

afc163's avatar
afc163 committed
82
## Usage
afc163's avatar
afc163 committed
83

陈帅's avatar
陈帅 committed
84 85
### Use bash

afc163's avatar
afc163 committed
86
```bash
Jeff Wen's avatar
Jeff Wen committed
87
$ git clone https://github.com/ant-design/ant-design-pro.git --depth=1
偏右's avatar
偏右 committed
88
$ cd ant-design-pro
afc163's avatar
afc163 committed
89
$ npm install
afc163's avatar
afc163 committed
90
$ npm start         # visit http://localhost:8000
afc163's avatar
afc163 committed
91 92
```

陈帅's avatar
陈帅 committed
93 94 95
### Use by docker

```bash
Sven Efftinge's avatar
Sven Efftinge committed
96
# preview
陈帅's avatar
陈帅 committed
97 98
$ docker pull antdesign/ant-design-pro
$ docker run -p 80:80 antdesign/ant-design-pro
陈帅's avatar
陈帅 committed
99 100
# open http://localhost

Sven Efftinge's avatar
Sven Efftinge committed
101
# dev
陈帅's avatar
陈帅 committed
102 103
$ npm run docker:dev

Sven Efftinge's avatar
Sven Efftinge committed
104
# build
陈帅's avatar
陈帅 committed
105 106 107
$ npm run docker:build


Sven Efftinge's avatar
Sven Efftinge committed
108
# production dev
陈帅's avatar
陈帅 committed
109 110
$ npm run docker-prod:dev

Sven Efftinge's avatar
Sven Efftinge committed
111
# production build
陈帅's avatar
陈帅 committed
112 113 114
$ npm run docker-prod:build
```

Sven Efftinge's avatar
Sven Efftinge committed
115 116 117 118 119 120
### 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
121
More instructions at [documentation](http://pro.ant.design/docs/getting-started).
偏右's avatar
偏右 committed
122

afc163's avatar
afc163 committed
123
## Browsers support
afc163's avatar
afc163 committed
124

afc163's avatar
afc163 committed
125
Modern browsers and IE11.
afc163's avatar
afc163 committed
126

afc163's avatar
afc163 committed
127 128 129 130
| [<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 |
| --------- | --------- | --------- | --------- | --------- |
| IE11, Edge| last 2 versions| last 2 versions| last 2 versions| last 2 versions

afc163's avatar
afc163 committed
131
## Contributing
偏右's avatar
偏右 committed
132

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

afc163's avatar
afc163 committed
135
- Use Ant Design Pro in your daily work.
Leonardo Farroco's avatar
Leonardo Farroco committed
136 137
- 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.