README.en-US.md 2.52 KB
Newer Older
偏右's avatar
偏右 committed
1 2 3 4
[简体中文](./README.md) | English

# Ant Design Pro

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

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

afc163's avatar
update  
afc163 committed
9
![](https://gw.alipayobjects.com/zos/rmsportal/xEdBqwSzvoSapmnSnYjU.png)
偏右's avatar
偏右 committed
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27

- 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

## Features

- :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

afc163's avatar
afc163 committed
28 29 30 31 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 58 59 60
## Templates

```
- Dashboard
  - 分析页
  - 监控页
  - 工作台
- 表单页
  - 基础表单页
  - 分步表单页
  - 高级表单页
- 列表页
  - 查询表格
  - 标准列表
  - 卡片列表
  - 搜索列表(项目/应用/文章)
- 详情页
  - 基础详情页
  - 高级详情页
- 结果
  - 成功页
  - 失败页
- 异常
  - 403 无权限
  - 404 找不到
  - 500 服务器出错
- 帐户
  - 登录
  - 注册
  - 注册成功
```

## Usage
偏右's avatar
偏右 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 65
$ cd ant-design-pro
$ npm install
afc163's avatar
afc163 committed
66
$ npm start         # visit http://localhost:8000
偏右's avatar
偏右 committed
67 68
```

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

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

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

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

Modern browsers and IE11.

偏右's avatar
偏右 committed
83 84 85 86 87
## Contributing

Any Contribution of following ways will be welcome:

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