124 lines
5.0 KiB
Markdown
124 lines
5.0 KiB
Markdown
Language: 🇺🇸 | [🇨🇳](./README.zh-CN.md) | [🇷🇺](./README.ru-RU.md) | [🇹🇷](./README.tr-TR.md) | [🇯🇵](./README.ja-JP.md) | [🇫🇷](./README.fr-FR.md) | [🇵🇹](./README.pt-BR.md) | [🇸🇦](./README.ar-DZ.md) | [🇪🇸](./README.es-ES.md)
|
||
|
||
<h1 align="center">Ant Design Pro</h1>
|
||
|
||
<div align="center">
|
||
|
||
An out-of-box UI solution for enterprise applications as a React boilerplate.
|
||
|
||
[](https://github.com/ant-design/ant-design-pro/actions/workflows/ci.yml)
|
||
[](https://github.com/ant-design/ant-design-pro/actions/workflows/preview-deploy.yml)
|
||
[](http://umijs.org/)
|
||
[](https://biomejs.dev)
|
||
[](https://ant.design/)
|
||
|
||
<img width="1718" height="1191" alt="light theme preview" src="https://github.com/user-attachments/assets/74ad0b4a-e086-4955-8edd-9f2cff31aee8" />
|
||
<img width="1718" height="1191" alt="dark theme preview" src="https://github.com/user-attachments/assets/d4bcb7c1-42c7-4c0f-b130-1193a931f9f7" />
|
||
|
||
</div>
|
||
|
||
- Preview: http://preview.pro.ant.design
|
||
- Home Page: http://pro.ant.design
|
||
- Documentation: http://pro.ant.design/docs/getting-started
|
||
- ChangeLog: http://pro.ant.design/docs/changelog
|
||
- FAQ: http://pro.ant.design/docs/faq
|
||
|
||
## Features
|
||
|
||
- :bulb: **TypeScript**: A language for application-scale JavaScript
|
||
- :scroll: **Blocks**: Build page with block template
|
||
- :gem: **Neat Design**: Follow [Ant Design specification](http://ant.design/)
|
||
- :triangular_ruler: **Common Templates**: Typical templates for enterprise applications
|
||
- :rocket: **State of The Art Development**: Newest development stack of React/umi/dva/antd
|
||
- :iphone: **Responsive**: Designed for variable screen sizes
|
||
- :art: **Theming**: Customizable theme with simple config
|
||
- :globe_with_meridians: **International**: Built-in i18n solution
|
||
- :gear: **Best Practices**: Solid workflow to make your code healthy
|
||
- :1234: **Mock development**: Easy to use mock development solution
|
||
- :white_check_mark: **UI Test**: Fly safely with unit and e2e tests
|
||
|
||
## Templates
|
||
|
||
```
|
||
- Dashboard
|
||
- 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
|
||
- Account
|
||
- Account Center
|
||
- Account Settings
|
||
- Result
|
||
- Success
|
||
- Failed
|
||
- Exception
|
||
- 403
|
||
- 404
|
||
- 500
|
||
- User
|
||
- Login
|
||
- Register
|
||
- Register Result
|
||
```
|
||
|
||
## Usage
|
||
|
||
### Use bash
|
||
|
||
We provide pro-cli to quickly initialize scaffolding.
|
||
|
||
```bash
|
||
# use npm
|
||
npm i @ant-design/pro-cli -g
|
||
pro create myapp
|
||
```
|
||
|
||
Choose the pro template. Simple is the basic template, which only provides the basic content of the framework operation. Complete contains all blocks, which is not suitable for secondary development as a basic template.
|
||
|
||
```shell
|
||
? 🚀 Full or a simple scaffold? (Use arrow keys)
|
||
❯ simple
|
||
complete
|
||
```
|
||
|
||
Initialized Git repository:
|
||
|
||
```shell
|
||
$ git init myapp
|
||
```
|
||
|
||
Install dependencies:
|
||
|
||
```shell
|
||
$ cd myapp && tyarn
|
||
// or
|
||
$ cd myapp && npm install
|
||
```
|
||
|
||
## Browsers support
|
||
|
||
Modern browsers.
|
||
|
||
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>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 |
|
||
| --- | --- | --- | --- | --- |
|
||
| Edge | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
|
||
|
||
## Contributing
|
||
|
||
Any type of contribution is welcome, here are some examples of how you may contribute to this project:
|
||
|
||
- Use Ant Design Pro in your daily work.
|
||
- 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.
|