diff --git a/bigtop-manager-ui/README.md b/bigtop-manager-ui/README.md index c93033201..70f775d2d 100644 --- a/bigtop-manager-ui/README.md +++ b/bigtop-manager-ui/README.md @@ -15,43 +15,53 @@ limitations under the License. ---> -# Bigtop-Manager-ui +# Bigtop Manager UI -Bigtop-Manager-ui is the front-end UI of the Manager platform, which stores code about the interaction between the platform and users, interface display, control styles, etc. +Bigtop Manager UI is the front-end UI of the Manager platform, which stores code about the interaction between the platform and users, interface display, control styles, etc. ## Prerequisites -Vite: Version 4.4.5 +- Node.js:`v18.17.0` -Typescript: Version 5.0.2 +- pnpm: `v8.6.9` -Vue: Version 3.3.4 +- Vite:`v5.4.19` -Editor: VsCode +- Typescript:`v5.8.3` + +- Vue:`v3.4.37` + +- Editor Recommendation: [Visual Studio Code](https://code.visualstudio.com/) ## Project Structure -``` -—————————————————— public static resources -—————————————————— src project source code -——————————— api calls the backend interface -——————————— assets static assets -——————————— components customize components -——————————— composables composable -——————————— directives customize directive -——————————— layouts overall page layout -——————————— locales internationalization -——————————— pages components -——————————— plugins global registration configuration -——————————— router router -——————————— store global persistence -——————————— styles style file -——————————— types data type -——————————— utils utility function -——————————— App.vue project root component -——————————— main.ts Project packaging portal -—————————————————— index.html Project page -—————————————————— package.json Package management profile for your project -—————————————————— vite.config.ts Project configuration file -—————————————————— postcss.config.ts postcss configuration file +```plaintext +├── public/ # Static assets +├── src/ # Source code root +│ ├── api/ # API request functions +│ ├── assets/ # Static assets +│ ├── components/ # Reusable component directory +│ │ ├── base/ # Basic UI components +│ │ ├── common/ # Common composite components +│ ├── composables/ # Vue composables +│ ├── directives/ # Custom directives +│ ├── features/ # Feature-based components +│ ├── layouts/ # Layout components +│ ├── locales/ # locale files (i18n) +│ ├── pages/ # Page components +│ ├── plugins/ # Plugins and global registrations +│ ├── router/ # Routing configuration +│ ├── store/ # Global state management +│ ├── styles/ # Global styles +│ ├── types/ # Global TypeScript declarations (.d.ts) +│ ├── utils/ # Utility functions +│ ├── App.vue # Root component +│ └── main.ts # Project entry point +├── tests/ # Unit and integration tests +├── index.html # HTML template +├── package.json # Project metadata and dependencies +├── tsconfig.json # TypeScript config file +├── vite.config.ts # Vite config +├── postcss.config.ts # PostCSS config +└── vitest.config.ts # Vitest config ``` diff --git a/bigtop-manager-ui/README.zh.md b/bigtop-manager-ui/README.zh.md index 241ca73e2..cac951494 100644 --- a/bigtop-manager-ui/README.zh.md +++ b/bigtop-manager-ui/README.zh.md @@ -15,43 +15,53 @@ limitations under the License. ---> -# Bigtop-Manager-ui +# Bigtop Manager UI -Bigtop-Manager-ui是Manager平台的前端UI,存放有关平台与用户交互,界面展示,控件样式等代码。 +Bigtop Manager UI 是 Manager 平台的前端 UI,存放有关平台与用户交互,界面展示,控件样式等代码。 ## 先决条件 -Vite:版本4.4.5 +- Node.js:`v18.17.0` -Typescript:版本5.0.2 +- pnpm: `v8.6.9` -Vue:版本3.3.4 +- Vite:`v5.4.19` -编辑器:VsCode +- Typescript:`v5.8.3` + +- Vue:`v3.4.37` + +- 推荐编辑器:[Visual Studio Code](https://code.visualstudio.com/) ## 项目结构 -``` -——————————————————public 公共静态资源 -——————————————————src 项目源代码 -——————————— api 调用后端接口 -——————————— assets 静态资源 -——————————— components 自定义组件 -——————————— composables 组合式函数 -——————————— directives 自定义指令 -——————————— layouts 整体页面布局 -——————————— locales 国际化 -——————————— pages 组件 -——————————— plugins 全局注册配置 -——————————— router 路由 -——————————— store 全局持久化 -——————————— styles 样式文件 -——————————— types 数据类型 -——————————— utils 工具函数 -——————————— App.vue 项目根组件 -——————————— main.ts 项目打包入口 -—————————————————— index.html 项目页面 -—————————————————— package.json 项目的包管理配置文件 -—————————————————— vite.config.ts 项目配置文件 -—————————————————— postcss.config.ts postcss 配置文件 +```plaintext +├── public/ # 公共静态资源 +├── src/ # 项目源代码目录 +│ ├── api/ # 后端接口封装 +│ ├── assets/ # 静态资源 +│ ├── components/ # 可复用组件目录 +│ │ ├── base/ # 基础组件 +│ │ ├── common/ # 常用复合组件 +│ ├── composables/ # Vue 组合式函数 +│ ├── directives/ # 自定义指令 +│ ├── features/ # 业务组件 +│ ├── layouts/ # 页面布局组件 +│ ├── locales/ # 国际化资源(i18n) +│ ├── pages/ # 页面级组件 +│ ├── plugins/ # 插件与全局注册逻辑 +│ ├── router/ # 路由配置 +│ ├── store/ # 全局状态管理 +│ ├── styles/ # 全局样式 +│ ├── types/ # 全局类型声明(.d.ts) +│ ├── utils/ # 工具函数 +│ ├── App.vue # 根组件 +│ └── main.ts # 项目入口文件 +├── tests/ # 单元测试或集成测试用例 +├── index.html # HTML 模板文件 +├── package.json # 包管理与脚本配置文件 +├── tsconfig.json # TypeScript 配置文件 +├── vite.config.ts # Vite 配置文件 +├── postcss.config.ts # PostCSS 配置 +└── vitest.config.ts # Vitest 测试配置文件 ``` diff --git a/bigtop-manager-ui/src/App.vue b/bigtop-manager-ui/src/App.vue index df598c764..091cd6a4e 100644 --- a/bigtop-manager-ui/src/App.vue +++ b/bigtop-manager-ui/src/App.vue @@ -18,10 +18,9 @@ --> diff --git a/bigtop-manager-ui/src/components/charts/category-chart.vue b/bigtop-manager-ui/src/features/metric/category-chart.vue similarity index 98% rename from bigtop-manager-ui/src/components/charts/category-chart.vue rename to bigtop-manager-ui/src/features/metric/category-chart.vue index c8035c754..3ed6cdbfa 100644 --- a/bigtop-manager-ui/src/components/charts/category-chart.vue +++ b/bigtop-manager-ui/src/features/metric/category-chart.vue @@ -19,7 +19,6 @@ diff --git a/bigtop-manager-ui/src/components/service-management/components.vue b/bigtop-manager-ui/src/features/service-management/components.vue similarity index 93% rename from bigtop-manager-ui/src/components/service-management/components.vue rename to bigtop-manager-ui/src/features/service-management/components.vue index 8f846ccfc..2f8bcfa7c 100644 --- a/bigtop-manager-ui/src/components/service-management/components.vue +++ b/bigtop-manager-ui/src/features/service-management/components.vue @@ -18,16 +18,11 @@ -->