144 lines
5.5 KiB
Markdown
144 lines
5.5 KiB
Markdown
<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/releases)
|
|
[](https://utoo.land)
|
|
[](https://umijs.org/)
|
|
[](https://biomejs.dev)
|
|
[](https://ant.design/)
|
|
|
|
Language: 🇺🇸 | [🇨🇳](./README.zh-CN.md)
|
|
|
|
<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: https://preview.pro.ant.design
|
|
- Documentation: [docs/cheatsheet.en-US.md](./docs/cheatsheet.en-US.md)
|
|
- ChangeLog: https://github.com/ant-design/ant-design-pro/releases
|
|
- FAQ: [docs/cheatsheet.en-US.md#faq](./docs/cheatsheet.en-US.md#faq)
|
|
- **v6 Released!** — [What's new in v6](https://github.com/ant-design/ant-design-pro/releases/tag/v6.0.0)
|
|
|
|
## Features
|
|
|
|
- :bulb: **TypeScript**: A language for application-scale JavaScript
|
|
- :scroll: **Blocks**: Build page with block template
|
|
- :gem: **Neat Design**: Built on [Ant Design 6](https://ant.design/) specification
|
|
- :triangular_ruler: **Common Templates**: Typical templates for enterprise applications
|
|
- :rocket: **State of The Art Development**: Newest development stack of React 19/[Umi Max 4](https://umijs.org/)/[antd 6](https://ant.design/)/[utoopack](https://utoo.land)
|
|
- :iphone: **Responsive**: Designed for variable screen sizes
|
|
- :art: **Theming**: Customizable theme with [Tailwind CSS v4](https://tailwindcss.com/) + [antd-style](https://github.com/ant-design/antd-style)
|
|
- :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
|
|
- :robot: **AI Assistant**: Built-in AI chatbot page powered by [Ant Design X](https://x.ant.design/)
|
|
- :white_check_mark: **UI Test**: Fly safely with unit and e2e tests
|
|
|
|
## Templates
|
|
|
|
```
|
|
- Welcome
|
|
- Dashboard
|
|
- Analysis
|
|
- Monitor
|
|
- Workplace
|
|
- Form
|
|
- Basic Form
|
|
- Step Form
|
|
- Advanced Form
|
|
- List
|
|
- Search List (Articles/Projects/Applications)
|
|
- Table List
|
|
- Basic List
|
|
- Card List
|
|
- Profile
|
|
- Basic Profile
|
|
- Advanced Profile
|
|
- Result
|
|
- Success
|
|
- Fail
|
|
- Exception
|
|
- 403
|
|
- 404
|
|
- 500
|
|
- Account
|
|
- Account Center
|
|
- Account Settings
|
|
- AI Assistant
|
|
- User
|
|
- Login
|
|
- Register
|
|
- Register Result
|
|
```
|
|
|
|
## Usage
|
|
|
|
### Get Started
|
|
|
|
Clone or download this repository to your local machine:
|
|
|
|
```bash
|
|
git clone --depth=1 https://github.com/ant-design/ant-design-pro.git myapp
|
|
cd myapp
|
|
```
|
|
|
|
### Installation
|
|
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
### Development
|
|
|
|
```bash
|
|
# Start development server (full version by default)
|
|
npm start
|
|
```
|
|
|
|
### Simplify to Simple Version
|
|
|
|
This project includes all blocks by default. If you need a minimal version, run:
|
|
|
|
```bash
|
|
npm run simple
|
|
```
|
|
|
|
This will:
|
|
- Remove extra page directories (dashboard, form, list/*, profile, result, exception, account, etc.)
|
|
- Remove extra mock files
|
|
- Replace routes with simple version
|
|
- Remove extra dependencies from package.json
|
|
|
|
**Note**: This operation is irreversible and will permanently delete files.
|
|
|
|
### Build
|
|
|
|
```bash
|
|
npm run build
|
|
```
|
|
|
|
## 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 |
|
|
| --- | --- | --- | --- |
|
|
| Edge | 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.
|
|
|
|
<a href="https://openomy.app/github/ant-design/ant-design-pro" target="_blank" style="display: block; width: 100%;" align="center">
|
|
<img src="https://openomy.app/svg?repo=ant-design/ant-design-pro&chart=bubble&latestMonth=3" target="_blank" alt="Contribution Leaderboard" style="display: block; width: 100%;" />
|
|
</a>
|