mirror of
https://github.com/zuiidea/antd-admin.git
synced 2026-10-19 16:14:37 +00:00
8673d8398e6747b377c0a8b97de69f791aa5a799
Focus root docs on init-antd-admin usage and keep template setup guidance fully in English with clearer CLI options. Made-with: Cursor
Antd Admin
A practical admin monorepo with two production-style templates, mock-first development, and test coverage.
apps/basic: English-only setupapps/with-lingui: Bilingual setup (en+zh) with Linguiapps/docs: Nextra documentation sitepackages/create:init-antd-adminscaffolding CLI
Links
Tech Stack
| Category | Technology |
|---|---|
| Build tool | Vite+ |
| UI | Ant Design 6.x |
| Routing | TanStack Router |
| Async state | TanStack Query v5 |
| Local state | Zustand |
| Validation | Zod v4 |
| i18n | LinguiJS in apps/with-lingui |
| Mocking | MSW 2.x |
| E2E tests | Playwright |
| Language | TypeScript 5.9 (strict) |
Highlights
- JWT login with access/refresh flow
- Backend-driven menu and permission guards
- URL-synced table state (pagination, sorting, search)
- Dark mode theme switching
- Mock-first local development (no backend required)
- Typed API boundaries and reusable CRUD patterns
Templates
| Template | Use when |
|---|---|
with-lingui |
You need multilingual UI (en + zh) and Lingui workflow |
basic |
You need a simpler English-only setup |
init-antd-admin Usage
Use the scaffolding CLI to create a standalone app from official templates.
Interactive
npx init-antd-admin@latest
pnpm dlx init-antd-admin@latest
yarn dlx init-antd-admin@latest
bunx init-antd-admin@latest
Non-interactive examples
pnpm dlx init-antd-admin@latest my-app --example basic -m pnpm
pnpm dlx init-antd-admin@latest my-app --example with-lingui --skip-install
Common options
| Option | Description |
|---|---|
[project-directory] |
Target folder |
| `-e, --example <name | url>` |
--example-path <path> |
Subpath inside remote repository |
-m, --package-manager <pm> |
npm / pnpm / yarn / bun |
--skip-install |
Skip dependency install |
--skip-transforms |
Skip rewrite transforms |
--no-git |
Skip git initialization |
For package-specific details, see packages/create/README.md.
Production docs: https://antd-admin-doc.zuiidea.top
License
MIT
Languages
TypeScript
83%
MDX
7.3%
JavaScript
5.9%
CSS
3.3%
HTML
0.3%
Other
0.2%