public/ruoyi-plus-vben5-h
1
0
Fork 0
mirror of https://github.com/imdap/ruoyi-plus-vben5.git synced 2026-04-23 00:38:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(@vben/docs): align guide docs with current tooling

Browse Source
This commit is contained in:
xingyu4j
2026-03-14 21:33:55 +08:00
parent 278032c94b
commit 6c274b75b8
11 changed files with 403 additions and 271 deletions
Download Patch File Download Diff File Expand all files Collapse all files

98
docs/src/en/guide/project/dir.md
View File

@@ -1,68 +1,72 @@
# Directory Explanation
The directory uses Monorepo management, and the project structure is as follows:
The repository uses Monorepo management, and the project structure is as follows:
```bash
.
├── Dockerfile # Docker image build file
├── README.md # Project documentation
├── apps # Project applications directory
│   ├── backend-mock # Backend mock service application
│   ├── web-antd # Frontend application based on Ant Design Vue
│   ├── web-ele # Frontend application based on Element Plus
│   └── web-naive # Frontend application based on Naive UI
├── build-local-docker-image.sh # Script for building Docker images locally
│ ├── backend-mock # Backend mock service application
│ ├── web-antd # Frontend application based on Ant Design Vue
│ ├── web-antdv-next # Frontend application based on Ant Design Vue Next
│ ├── web-ele # Frontend application based on Element Plus
│ ├── web-naive # Frontend application based on Naive UI
│ └── web-tdesign # Frontend application based on TDesign
├── cspell.json # CSpell configuration file
├── docs # Project documentation directory
├── eslint.config.mjs # ESLint configuration file
├── lefthook.yml # Git hook configuration file
├── internal # Internal tools directory
│   ├── lint-configs # Code linting configurations
│   │   ├── commitlint-config # Commitlint configuration
│   │   ├── eslint-config # ESLint configuration
│   │   ├── prettier-config # Prettier configuration
│   │   └── stylelint-config # Stylelint configuration
│   ├── node-utils # Node.js tools
│   ├── tailwind-config # Tailwind configuration
│   ├── tsconfig # Common tsconfig settings
│   └── vite-config # Common Vite configuration
│ ├── lint-configs # Code linting configurations
│ │ ├── commitlint-config # Commitlint configuration
│ │ ├── eslint-config # ESLint configuration
│ │ ├── oxfmt-config # Oxfmt configuration
│ │ ├── oxlint-config # Oxlint configuration
│ │ └── stylelint-config # Stylelint configuration
│ ├── node-utils # Node.js tools
│ ├── tsconfig # Common tsconfig settings
│ └── vite-config # Common Vite configuration
├── oxfmt.config.ts # Oxfmt config entry
├── oxlint.config.ts # Oxlint configuration file
├── package.json # Project dependency configuration
├── packages # Project packages directory
│   ├── @core # Core package
│   │   ├── base # Base package
│   │   │   ├── design # Design related
│   │   │   ├── icons # Icons
│   │   │   ├── shared # Shared
│   │   │   └── typings # Type definitions
│   │   ├── composables # Composable APIs
│   │   ├── preferences # Preferences
│   │   └── ui-kit # UI component collection
│   │   ├── layout-ui # Layout UI
│   │   ├── menu-ui # Menu UI
│   │   ├── shadcn-ui # shadcn UI
│   │   └── tabs-ui # Tabs UI
│   ├── constants # Constants
│   ├── effects # Effects related packages
│   │   ├── access # Access control
│   │   ├── plugins # Plugins
│   │   ├── common-ui # Common UI
│   │   ├── hooks # Composable APIs
│   │   ├── layouts # Layouts
│   │   └── request # Request
│   ├── icons # Icons
│   ├── locales # Internationalization
│   ├── preferences # Preferences
│   ├── stores # State management
│   ├── styles # Styles
│   ├── types # Type definitions
│   └── utils # Utilities
│ ├── @core # Core package
│ │ ├── base # Base package
│ │ │ ├── design # Design related
│ │ │ ├── icons # Icons
│ │ │ ├── shared # Shared
│ │ │ └── typings # Type definitions
│ │ ├── composables # Composable APIs
│ │ ├── preferences # Preferences
│ │ └── ui-kit # UI component collection
│ │ ├── layout-ui # Layout UI
│ │ ├── menu-ui # Menu UI
│ │ ├── shadcn-ui # shadcn UI
│ │ └── tabs-ui # Tabs UI
│ ├── constants # Constants
│ ├── effects # Effects related packages
│ │ ├── access # Access control
│ │ ├── plugins # Large third-party dependency plugins
│ │ ├── common-ui # Common UI
│ │ ├── hooks # Composable APIs
│ │ ├── layouts # Layouts
│ │ └── request # Request
│ ├── icons # Icons
│ ├── locales # Internationalization
│ ├── preferences # Preferences
│ ├── stores # State management
│ ├── styles # Styles
│ ├── types # Type definitions
│ └── utils # Utilities
├── playground # Demo directory
├── pnpm-lock.yaml # pnpm lock file
├── pnpm-workspace.yaml # pnpm workspace configuration file
├── scripts # Scripts directory
│   ├── turbo-run # Turbo run script
│   └── vsh # VSH script
│ ├── deploy # Deployment-related scripts
│ ├── turbo-run # Turbo run script
│ └── vsh # VSH script
├── stylelint.config.mjs # Stylelint configuration file
├── turbo.json # Turbo configuration file
├── vben-admin.code-workspace # VS Code workspace configuration file
└── vitest.config.ts # Vite configuration file
└── vitest.config.ts # Vitest configuration file
```