mirror of
https://github.com/zuiidea/antd-admin
synced 2026-10-28 20:03:57 +00:00
zuiideaandCursor
2614328537
Add root preinstall to set githooks and disable parallel vp config git lock races; merge per-app Cursor thin rules into app.mdx; keep template READMEs free of monorepo-only paths and describe basic as default English rather than English-only. Co-authored-by: Cursor <cursoragent@cursor.com>
Antd Admin
Introduction
Antd Admin provides production-style admin templates with modern frontend tooling, mock-first development, and practical testing coverage.
Available templates:
basic: Admin template with plain-string UI copy (default English; no bundled Lingui)with-lingui: Lingui i18n workflow (en+zh) with locale switching
Scaffolding CLI:
init-antd-admin(frompackages/create)
Key Features
- 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
- React 19 + Ant Design 6 + TanStack Router/Query + Zustand + Zod
- Optional Lingui-based i18n workflow (
with-lingui) - E2E coverage with Playwright
Quick Start
Use init-antd-admin to scaffold 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 detailed CLI behavior, see [packages/create/README.md](./packages/create/README.md).
Working in this monorepo (Cursor)
Template apps ship scoped guidance under each app’s .github/instructions/ (see each app’s README.md). Monorepo-only: root .cursor/rules/app.mdx is a thin router to those files when editing apps/with-lingui or apps/basic; it is not included in init-antd-admin output.
Production docs: https://antd-admin-doc.zuiidea.top
Links
License
MIT