ant-design-pro README

The project's README from github.com/ant-design/ant-design-pro. As one markdown file: README.md.

Ant Design Pro

An out-of-box UI solution for enterprise applications as a React boilerplate.

CI GitHub release Build With Utoo Build With Umi Checked with Biome Ant Design

Language: English | 简体中文

light theme preview dark theme preview

Features

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:

git clone --depth=1 https://github.com/ant-design/ant-design-pro.git myapp
cd myapp

Installation

npm install

Development

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

npm run simple

This will:

Note: This operation is irreversible and will permanently delete files.

Build

npm run build

AI Skills (Claude Code)

This project ships with two built-in Claude Code Skills in .claude/skills/:

Skill Trigger Description
/pro-upgrade "upgrade pro", "update to latest" Auto-upgrade to the latest Ant Design Pro version. Diffs the latest template, merges framework changes while preserving your business code.
/antd antd-related code or questions Query antd component APIs, props, tokens, demos; lint for deprecated usage; migrate between versions — all via @ant-design/cli.

Usage in Claude Code:

# Upgrade the project to latest Pro version
/pro-upgrade

# Query antd component info, debug issues, run lint, etc.
/antd

💡 If your project was cloned from this repo, these skills are already included — no installation needed. To get the latest skill definitions, pull the updates from the template or run npx skills add ant-design/ant-design-pro to refresh them.

Browsers support

Modern browsers.

Edge
Edge
Firefox
Firefox
Chrome
Chrome
Safari
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:

Contribution Leaderboard

ant-design-pro (ant-design/ant-design-pro)

boilerplate
Searching Database…

What is this?Ant Design Pro is an out-of-the-box UI boilerplate for building enterprise admin applications, built on top of Ant Design and React.
Is this a component library or a full boilerplate project?It's a full React boilerplate/scaffold you clone and build on, not just a component package — it ships with page templates, routing, mock data, and i18n already wired up.
How do I get started with it?Clone or download the repository, install dependencies, then run the dev script to start the development server.
What's the tech stack behind it?It runs on React 19, Umi Max 4, and antd 6, written in TypeScript, and requires Node.js 22 or newer.
Can I strip it down if I don't need all the sample pages?Yes, there's a script to simplify the project to a minimal version, but it permanently deletes extra page directories, mocks, and routes — the operation is irreversible.
Does it work on Intel and AMD machines too, or any specific platform?It's a web app built with standard web tooling, so it runs anywhere Node.js and modern browsers run — no special hardware needed.
What AI features does it have built in?It ships with two built-in Claude Code Skills (/pro-upgrade and /antd) for auto-upgrading the template and querying/linting antd component usage, plus a built-in AI chatbot page powered by Ant Design X.
Can I theme or customize the look?Yes, it supports a customizable theme system using Tailwind CSS v4 combined with antd-style.
Does it support multiple languages out of the box?Yes, it has a built-in internationalization (i18n) solution and README is available in English and Simplified Chinese.
Which browsers are supported?Modern browsers only: the last 2 versions of Edge, Firefox, Chrome, and Safari.
Creator
ant-design
Size
41.3 MB
Stars
38.9K
Age
9y
Commits · 90 Days