Skip to content

Directory Explanation โ€‹ โ€‹

The repository uses Monorepo management, and the project structure is as follows:

bash
bash
.
โ”œโ”€โ”€ README.md # Project documentation
โ”œโ”€โ”€ apps # Project applications directory
โ”‚   โ”œโ”€โ”€ 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
โ”‚   โ”‚   โ”œโ”€โ”€ 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 # 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
โ”‚   โ”œโ”€โ”€ 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 # Vitest configuration file

Contributors

Changelog

Released under the MIT License.