Skip to content

Directory Structure

vue3-naiveui-admin
ini
โ”œโ”€ .husky                   # Git commit hooks
โ”œโ”€ .vscode                  # VSCode recommended settings
โ”œโ”€ build                    # Build configuration files
โ”‚  โ”œโ”€ buildOptions.ts        # Vite build configuration
โ”‚  โ”œโ”€ cssOptions.ts          # CSS configuration
โ”‚  โ”œโ”€ htmlPlugin.ts          # Custom Vite plugin
โ”‚  โ”œโ”€ index.ts               # Build entry
โ”‚  โ”œโ”€ optimizeDepsOptions.ts # Dependency optimization configuration
โ”‚  โ”œโ”€ pluginsOptions.ts      # Plugin configuration
โ”‚  โ”œโ”€ resolveOptions.ts      # Path configuration
โ”‚  โ””โ”€ serverOptions.ts       # Development server configuration
โ”œโ”€ locales                  # Internationalization files
โ”œโ”€ public                   # Static assets (this folder is not bundled)
โ”œโ”€ sql                      # Database scripts
โ”‚  โ””โ”€ youlai_admin.sql       # Base database script
โ”œโ”€ src                      # Source code
โ”‚  โ”œโ”€ api                   # API management
โ”‚  โ”œโ”€ assets                # Static assets
โ”‚     โ””โ”€โ”€ svg-icons          # Custom SVG icon resources (local icon source for icon picker)
โ”‚  โ”œโ”€ components            # Global components
โ”‚  โ”œโ”€ directives            # Global directive files
โ”‚  โ”œโ”€ enums                 # Enum files
โ”‚  โ”œโ”€ hooks                 # Common Hooks encapsulation
โ”‚     โ”œโ”€โ”€ useSse/*           # SSE subscription
โ”‚     โ”œโ”€โ”€ index.ts           # Unified export of global Hooks
โ”‚     โ”œโ”€โ”€ useBoolean.ts      # Composable for Boolean
โ”‚     โ”œโ”€โ”€ useCompRef.ts      # Composable for ref
โ”‚     โ”œโ”€โ”€ useDict.ts         # Get dictionary data
โ”‚     โ”œโ”€โ”€ useKeepTicking.ts  # Composable timer hook
โ”‚     โ”œโ”€โ”€ useLoading.ts      # Composable for loading
โ”‚     โ”œโ”€โ”€ useRange.ts        # List search time range handling
โ”‚     โ””โ”€โ”€ useResponsive.ts   # Responsive layout
โ”‚  โ”œโ”€ layout                # Framework layout module
โ”‚     โ”œโ”€โ”€ components         # Layout internal components
โ”‚     โ”œโ”€โ”€ main               # Layout framework
โ”‚     โ””โ”€โ”€ index.txs          # Layout component shell
โ”‚  โ”œโ”€ modules               # Global module registration
โ”‚     โ”œโ”€โ”€ assets.ts          # Static resources
โ”‚     โ”œโ”€โ”€ directives.ts      # Directives
โ”‚     โ””โ”€โ”€ i18n.ts            # Internationalization
โ”‚  โ”œโ”€ plugins               # Global plugin registration
โ”‚     โ”œโ”€โ”€ appVersion.ts      # App update prompt refresh
โ”‚     โ”œโ”€โ”€ index.ts           # Unified export
โ”‚     โ””โ”€โ”€ sse.ts             # SSE subscription
โ”‚  โ”œโ”€ router                # Route management
โ”‚     โ”œโ”€โ”€ modules            # Route modules
โ”‚         โ”œโ”€โ”€ guard.ts        # Route guard configuration
โ”‚         โ””โ”€โ”€ routes.ts       # Local static page routes
โ”‚     โ””โ”€โ”€ index.ts           # Route instance export
โ”‚  โ”œโ”€ store                 # Pinia store
โ”‚     โ”œโ”€โ”€ modules            # Store modules
โ”‚         โ”œโ”€โ”€ app.ts     # Style/layout settings storage
โ”‚         โ”œโ”€โ”€ auth.ts         # User permissions storage
โ”‚         โ”œโ”€โ”€ dict.ts         # Dictionary storage
โ”‚         โ”œโ”€โ”€ routes.ts       # Route-related storage
โ”‚         โ”œโ”€โ”€ tab.ts          # Tab storage
โ”‚         โ””โ”€โ”€ watermark.ts    # Watermark storage
โ”‚     โ””โ”€โ”€ index.ts           # Store instance export
โ”‚  โ”œโ”€ styles                # Global style files
โ”‚     โ”œโ”€โ”€ index.css          # Unified export entry
โ”‚     โ”œโ”€โ”€ naive.css          # Override NaiveUI default styles
โ”‚     โ”œโ”€โ”€ reset.css          # Reset CSS
โ”‚     โ”œโ”€โ”€ transition.css     # Transition styles
โ”‚     โ””โ”€โ”€ wangEditor.css     # wangEditor rich text editor styles
โ”‚  โ”œโ”€ types                 # Global TypeScript declarations
โ”‚  โ”œโ”€ typings               # Auto-import type files (this directory can be deleted; regenerated on project start)
โ”‚     โ”œโ”€โ”€ auto-imports.d.ts  # Auto-import methods type file
โ”‚     โ””โ”€โ”€ components.d.ts    # Auto-import components type file
โ”‚  โ”œโ”€ utils                 # Common utility library
โ”‚     โ”œโ”€โ”€ comm.ts            # Common utility methods
โ”‚     โ”œโ”€โ”€ i18n.ts            # Internationalization methods
โ”‚     โ”œโ”€โ”€ icon.ts            # Icon utilities
โ”‚     โ”œโ”€โ”€ index.ts           # Utility class unified export entry
โ”‚     โ”œโ”€โ”€ is.ts              # Various type checks
โ”‚     โ”œโ”€โ”€ jsencrypt.ts       # Encrypt/decrypt helpers
โ”‚     โ”œโ”€โ”€ request.ts         # Axios request encapsulation
โ”‚     โ”œโ”€โ”€ router.ts          # Route utilities
โ”‚     โ”œโ”€โ”€ spin.ts            # Loading animation and common async operation helpers
โ”‚     โ”œโ”€โ”€ storage.ts         # Storage encapsulation
โ”‚     โ””โ”€โ”€ theme.ts           # Theme configuration
โ”‚  โ”œโ”€ views                 # All project pages
โ”‚  โ”œโ”€ App.tsx               # APP root component
โ”‚  โ””โ”€ main.ts               # Project entry file
โ”œโ”€ .env.development        # Development environment configuration
โ”œโ”€ .env.production         # Production environment configuration
โ”œโ”€ .eslintrc-auto-import.json  # ESLint auto-import configuration
โ”œโ”€ .gitignore              # Git ignore rules
โ”œโ”€ .prettierignore         # Prettier ignore
โ”œโ”€ .stylelintignore        # Stylelint ignore
โ”œโ”€ commitlint.config.mjs   # Commit message rules
โ”œโ”€ eslint.config.ts        # ESLint rules configuration
โ”œโ”€ index.html              # Entry HTML
โ”œโ”€ LICENSE                 # Open source license file
โ”œโ”€ package.json            # Dependency management
โ”œโ”€ pnpm-lock.json          # Dependency lock file
โ”œโ”€ prettier.config.mjs     # Prettier rules configuration
โ”œโ”€ README.md               # README introduction
โ”œโ”€ stylelint.config.mjs    # Stylelint rules configuration
โ”œโ”€ tsconfig.json           # TypeScript global configuration
โ”œโ”€ unocss.config.js        # UnoCSS configuration
โ””โ”€ vite.config.ts          # Vite global configuration file

Contributors

Changelog

Released under the MIT License