Skip to content

Project Structure โ€‹

โ”œโ”€โ”€ src
โ”‚   โ”œโ”€โ”€ api                     # API interface related code
โ”‚   โ”‚   โ”œโ”€โ”€ auth.ts             # Authentication API definitions (login, register, user info)
โ”‚   โ”‚   โ””โ”€โ”€ system-manage.ts    # System management API definitions (menu, user, role management)
โ”‚   โ”œโ”€โ”€ App.vue                 # Vue root component, defines global app structure and entry
โ”‚   โ”œโ”€โ”€ assets                  # Static assets directory
โ”‚   โ”‚   โ”œโ”€โ”€ images              # Image resources directory
โ”‚   โ”‚   โ”œโ”€โ”€ styles              # Global style files
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ core            # Core styles (system-level styles)
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ custom          # Custom styles (business-level styles)
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ index.scss      # Style entry file
โ”‚   โ”‚   โ””โ”€โ”€ svg                 # SVG related resources
โ”‚   โ”‚       โ””โ”€โ”€ loading.ts      # Loading animation SVG definitions
โ”‚   โ”œโ”€โ”€ components              # Components directory
โ”‚   โ”‚   โ”œโ”€โ”€ business            # Business components (custom business-related components)
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ comment-widget  # Comment component
โ”‚   โ”‚   โ””โ”€โ”€ core                # Core components (system-level common component library)
โ”‚   โ”‚       โ”œโ”€โ”€ banners         # Banner components
โ”‚   โ”‚       โ”œโ”€โ”€ base            # Base components
โ”‚   โ”‚       โ”œโ”€โ”€ cards           # Card components
โ”‚   โ”‚       โ”œโ”€โ”€ charts          # Chart components
โ”‚   โ”‚       โ”œโ”€โ”€ forms           # Form components
โ”‚   โ”‚       โ”œโ”€โ”€ layouts         # Layout components
โ”‚   โ”‚       โ”œโ”€โ”€ media           # Media components
โ”‚   โ”‚       โ”œโ”€โ”€ others          # Other components
โ”‚   โ”‚       โ”œโ”€โ”€ tables          # Table components
โ”‚   โ”‚       โ”œโ”€โ”€ text-effect     # Text effect components
โ”‚   โ”‚       โ”œโ”€โ”€ theme           # Theme related components
โ”‚   โ”‚       โ”œโ”€โ”€ views           # View components
โ”‚   โ”‚       โ””โ”€โ”€ widget          # Widget components
โ”‚   โ”œโ”€โ”€ config                  # Project configuration directory
โ”‚   โ”‚   โ”œโ”€โ”€ assets              # Static assets configuration
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ images.ts       # Image resource path configuration
โ”‚   โ”‚   โ”œโ”€โ”€ modules             # Modular configuration
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ component.ts    # Component configuration
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ fastEnter.ts    # Quick entry configuration
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ festival.ts     # Festival/event configuration
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ headerBar.ts    # Header bar configuration
โ”‚   โ”‚   โ”œโ”€โ”€ index.ts            # Configuration entry file
โ”‚   โ”‚   โ””โ”€โ”€ setting.ts          # System settings configuration
โ”‚   โ”œโ”€โ”€ directives              # Vue custom directives
โ”‚   โ”‚   โ”œโ”€โ”€ business            # Business directives
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ highlight.ts    # Highlight directive
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ ripple.ts       # Ripple effect directive
โ”‚   โ”‚   โ”œโ”€โ”€ core                # Core directives
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ auth.ts         # Authentication directive
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ roles.ts        # Role permission directive
โ”‚   โ”‚   โ””โ”€โ”€ index.ts            # Directives entry file
โ”‚   โ”œโ”€โ”€ enums                   # Enum definitions
โ”‚   โ”‚   โ”œโ”€โ”€ appEnum.ts          # Application-level enums (theme types, language types)
โ”‚   โ”‚   โ””โ”€โ”€ formEnum.ts         # Form related enums (form states, validation rules)
โ”‚   โ”œโ”€โ”€ env.d.ts                # TypeScript environment declaration file
โ”‚   โ”œโ”€โ”€ hooks                   # Vue 3 Composable functions (reusable logic)
โ”‚   โ”‚   โ”œโ”€โ”€ core                # Core Hooks
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ useAppMode.ts   # Application mode related logic
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ useAuth.ts      # Authentication related logic
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ useCeremony.ts  # Festival/ceremony related logic
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ useChart.ts     # Chart related logic
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ useCommon.ts    # Common logic
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ useFastEnter.ts # Quick entry logic
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ useHeaderBar.ts # Header bar logic
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ useLayoutHeight.ts # Layout height calculation logic
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ useTable.ts     # Table logic
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ useTableColumns.ts # Table column configuration logic
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ useTableHeight.ts # Table height calculation logic
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ useTheme.ts     # Theme switching logic
โ”‚   โ”‚   โ””โ”€โ”€ index.ts            # Hooks entry file
โ”‚   โ”œโ”€โ”€ locales                 # Internationalization (i18n) resources
โ”‚   โ”‚   โ”œโ”€โ”€ index.ts            # Internationalization entry file
โ”‚   โ”‚   โ””โ”€โ”€ langs               # Multi-language files
โ”‚   โ”‚       โ”œโ”€โ”€ en.json         # English language pack
โ”‚   โ”‚       โ””โ”€โ”€ zh.json         # Chinese language pack
โ”‚   โ”œโ”€โ”€ main.ts                 # Project main entry file
โ”‚   โ”œโ”€โ”€ mock                    # Mock data directory
โ”‚   โ”‚   โ”œโ”€โ”€ json                # JSON format mock data
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ chinaMap.json   # China map data
โ”‚   โ”‚   โ”œโ”€โ”€ temp                # Temporary mock data
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ articleList.ts  # Article list data
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ commentDetail.ts # Comment detail data
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ commentList.ts  # Comment list data
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ formData.ts     # Form data
โ”‚   โ”‚   โ””โ”€โ”€ upgrade             # Update log data
โ”‚   โ”‚       โ””โ”€โ”€ changeLog.ts    # Change log data
โ”‚   โ”œโ”€โ”€ plugins                 # Plugin configuration
โ”‚   โ”‚   โ”œโ”€โ”€ echarts.ts          # ECharts library configuration
โ”‚   โ”‚   โ””โ”€โ”€ index.ts            # Plugins entry file
โ”‚   โ”œโ”€โ”€ router                  # Vue Router related code
โ”‚   โ”‚   โ”œโ”€โ”€ core                # Router core functionality
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ ComponentLoader.ts # Component loader
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ IframeRouteManager.ts # Iframe route manager
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ MenuProcessor.ts # Menu processor
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ RouteRegistry.ts # Route registry
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ RouteTransformer.ts # Route transformer
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ RouteValidator.ts # Route validator
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ index.ts        # Core functionality entry
โ”‚   โ”‚   โ”œโ”€โ”€ guards              # Route guards
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ afterEach.ts    # Global after guard
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ beforeEach.ts   # Global before guard
โ”‚   โ”‚   โ”œโ”€โ”€ modules             # Route module definitions
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ article.ts      # Article module routes
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ dashboard.ts    # Dashboard routes
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ examples.ts     # Example page routes
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ exception.ts    # Exception page routes
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ help.ts         # Help page routes
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ index.ts        # Route modules entry
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ result.ts       # Result page routes
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ safeguard.ts    # Security protection routes
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ system.ts       # System management routes
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ template.ts     # Template page routes
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ widgets.ts      # Widget routes
โ”‚   โ”‚   โ”œโ”€โ”€ routes              # Route configuration
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ asyncRoutes.ts  # Async routes (dynamic routes)
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ staticRoutes.ts # Static routes (fixed routes)
โ”‚   โ”‚   โ”œโ”€โ”€ index.ts            # Router main entry
โ”‚   โ”‚   โ””โ”€โ”€ routesAlias.ts      # Route alias definitions
โ”‚   โ”œโ”€โ”€ store                   # Pinia state management
โ”‚   โ”‚   โ”œโ”€โ”€ modules             # State management modules
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ menu.ts         # Menu state management
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ setting.ts      # Settings state management
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ table.ts        # Table state management
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ user.ts         # User state management
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ worktab.ts      # Work tab state management
โ”‚   โ”‚   โ””โ”€โ”€ index.ts            # Pinia entry file
โ”‚   โ”œโ”€โ”€ types                   # TypeScript type definitions
โ”‚   โ”‚   โ”œโ”€โ”€ api                 # API related types
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ api.d.ts        # API interface type definitions
โ”‚   โ”‚   โ”œโ”€โ”€ common              # Common type definitions
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ index.ts        # Common types entry
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ response.ts     # Response type definitions
โ”‚   โ”‚   โ”œโ”€โ”€ component           # Component related types
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ chart.ts        # Chart component types
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ index.ts        # Component types entry
โ”‚   โ”‚   โ”œโ”€โ”€ config              # Configuration related types
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ index.ts        # Configuration type definitions
โ”‚   โ”‚   โ”œโ”€โ”€ import              # Auto-import type declarations
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ auto-imports.d.ts # Auto-imported function types
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ components.d.ts # Auto-imported component types
โ”‚   โ”‚   โ”œโ”€โ”€ router              # Router related types
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ index.ts        # Router type definitions
โ”‚   โ”‚   โ”œโ”€โ”€ store               # State management related types
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ index.ts        # Store type definitions
โ”‚   โ”‚   โ””โ”€โ”€ index.ts            # Types main entry
โ”‚   โ”œโ”€โ”€ utils                   # Utility functions directory
โ”‚   โ”‚   โ”œโ”€โ”€ constants           # Constant definitions
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ index.ts        # Constants entry
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ links.ts        # Link constants
โ”‚   โ”‚   โ”œโ”€โ”€ form                # Form related utilities
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ index.ts        # Form utilities entry
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ responsive.ts   # Responsive form utilities
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ validator.ts    # Form validation utilities
โ”‚   โ”‚   โ”œโ”€โ”€ http                # HTTP request utilities
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ error.ts        # Error handling
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ index.ts        # HTTP utilities entry
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ status.ts       # Status code handling
โ”‚   โ”‚   โ”œโ”€โ”€ navigation          # Navigation related utilities
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ index.ts        # Navigation utilities entry
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ jump.ts         # Page jump utilities
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ route.ts        # Route utilities
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ worktab.ts      # Work tab utilities
โ”‚   โ”‚   โ”œโ”€โ”€ storage             # Storage related utilities
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ index.ts        # Storage utilities entry
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ storage-config.ts # Storage configuration
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ storage-key-manager.ts # Storage key manager
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ storage.ts      # Storage utilities implementation
โ”‚   โ”‚   โ”œโ”€โ”€ sys                 # System related utilities
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ console.ts      # Console utilities
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ error-handle.ts # Error handling
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ index.ts        # System utilities entry
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ mittBus.ts      # Event bus
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ upgrade.ts      # Upgrade related utilities
โ”‚   โ”‚   โ”œโ”€โ”€ table               # Table related utilities
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ tableCache.ts   # Table cache
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ tableConfig.ts  # Table configuration
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ tableUtils.ts   # Table utility functions
โ”‚   โ”‚   โ”œโ”€โ”€ ui                  # UI related utilities
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ animation.ts    # Animation utilities
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ colors.ts       # Color utilities
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ emojo.ts        # Emoji utilities
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ index.ts        # UI utilities entry
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ loading.ts      # Loading animation utilities
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ tabs.ts         # Tab utilities
โ”‚   โ”‚   โ”œโ”€โ”€ index.ts            # Utilities main entry
โ”‚   โ”‚   โ””โ”€โ”€ router.ts           # Router utility functions
โ”‚   โ””โ”€โ”€ views                   # Page components directory
โ”œโ”€โ”€ tsconfig.json               # TypeScript configuration file
โ””โ”€โ”€ vite.config.ts              # Vite configuration file

Released under the MIT License