docs: 更新 README 文档

2024-04-28 22:12:02 +08:00 · 2024-04-24 22:45:23 +08:00
12 changed files with 4182 additions and 2800 deletions
--- a/.github/workflows/deploy.yml
+++ b/.github/workflows/deploy.yml
@@ -1,56 +0,0 @@
-name: Deploy
-
-on:
-  # 推送时执行
-  push:
-    branches: [dev]
-  # 可手动执行
-  workflow_dispatch:
-
-jobs:
-  deploy-web:
-    runs-on: ubuntu-latest
-    steps:
-      # 1、检出源码
-      - name: Checkout
-        uses: actions/checkout@master
-      # 2、安装 PNPM
-      - name: Setup PNPM
-        uses: pnpm/action-setup@v2
-        with:
-          version: latest
-      # 3、安装 Node 环境
-      - name: Setup Node
-        uses: actions/setup-node@v3
-        with:
-          node-version: 16
-          cache: pnpm
-          cache-dependency-path: ./pnpm-lock.yaml
-      # 4、安装依赖
-      - name: Install Dependencies
-        run: pnpm i --frozen-lockfile
-      # 5、打包
-      - name: Build
-        run: pnpm build
-      # 6、拷贝到服务器
-      - name: Copy
-        uses: garygrossgarten/github-action-scp@release
-        with:
-          host: ${{ secrets.SERVER_HOST }}
-          port: ${{ secrets.SERVER_PORT }}
-          username: ${{ secrets.SERVER_USERNAME }}
-          password: ${{ secrets.SERVER_PASSWORD }}
-          local: ./dist
-          remote: /docker/continew-admin/tmp
-      # 7、重启 Nginx
-      - name: Restart
-        uses: appleboy/ssh-action@master
-        with:
-          host: ${{ secrets.SERVER_HOST }}
-          port: ${{ secrets.SERVER_PORT }}
-          username: ${{ secrets.SERVER_USERNAME }}
-          password: ${{ secrets.SERVER_PASSWORD }}
-          script: |
-            rm -rf /docker/continew-admin/html/*
-            mv /docker/continew-admin/tmp/* /docker/continew-admin/html
-            docker restart nginx
--- a/.github/workflows/release-tag.yml
+++ b/.github/workflows/release-tag.yml
@@ -1,23 +0,0 @@
-name: Release
-
-on:
-  push:
-    tags:
-      - 'v*' # Push events to matching v*, i.e. v1.0.0
-
-jobs:
-  release:
-    if: github.repository == 'Charles7c/continew-admin-ui'
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@master
-      - name: Create Release for Tag
-        id: release_tag
-        uses: yyx990803/release-tag@master
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          tag_name: ${{ github.ref }}
-          body: |
-            详情请参阅 [CHANGELOG.md](https://github.com/${{ github.repository }}/blob/dev/CHANGELOG.md) 。
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,45 +2,45 @@

 ### ✨ 新特性

-* 新增代码批量生成功能 ([2353caf](https://github.com/Charles7c/continew-admin-ui/commit/2353caffa9ddfbf8c0f9657c1f2e89b14eff38db))
+* 新增代码批量生成功能 ([2353caf](https://github.com/Charles7c/continew-admin-ui-arco/commit/2353caffa9ddfbf8c0f9657c1f2e89b14eff38db))

 ### 💎 功能优化

- 调整代码生成 API 地址 ([b4bb469](https://github.com/Charles7c/continew-admin-ui/commit/b4bb4693dfd694bcc5f10be32cf7d405af92367e))
- 适配部分 API 响应格式调整为 kv 格式的变化 ([6f5c35e](https://github.com/Charles7c/continew-admin-ui/commit/6f5c35ea77b1e3880bca477ec027d074915341e8))
- 调整文件管理配置存储库按钮风格 ([aeafc2e](https://github.com/Charles7c/continew-admin-ui/commit/aeafc2ece2012b53bfe8ff6c64fed9ad73f9d188))
- 代码生成字段配置增加字段排序信息 ([e9d3865](https://github.com/Charles7c/continew-admin-ui/commit/e9d38658920f49e0bb0600e779621c44d388057e))
- 优化部分 ref API 使用方式 ([e6fa9f6](https://github.com/Charles7c/continew-admin-ui/commit/e6fa9f60a927f639b8b7f6145982a395506b3150))
- 重构代码生成功能，由指定路径生成模式调整为下载模式，更方便复杂场景 ([7792cd3](https://github.com/Charles7c/continew-admin-ui/commit/7792cd398f6c4a2d10187cb548ba687dc8f62c84))
+- 调整代码生成 API 地址 ([b4bb469](https://github.com/Charles7c/continew-admin-ui-arco/commit/b4bb4693dfd694bcc5f10be32cf7d405af92367e))
+- 适配部分 API 响应格式调整为 kv 格式的变化 ([6f5c35e](https://github.com/Charles7c/continew-admin-ui-arco/commit/6f5c35ea77b1e3880bca477ec027d074915341e8))
+- 调整文件管理配置存储库按钮风格 ([aeafc2e](https://github.com/Charles7c/continew-admin-ui-arco/commit/aeafc2ece2012b53bfe8ff6c64fed9ad73f9d188))
+- 代码生成字段配置增加字段排序信息 ([e9d3865](https://github.com/Charles7c/continew-admin-ui-arco/commit/e9d38658920f49e0bb0600e779621c44d388057e))
+- 优化部分 ref API 使用方式 ([e6fa9f6](https://github.com/Charles7c/continew-admin-ui-arco/commit/e6fa9f60a927f639b8b7f6145982a395506b3150))
+- 重构代码生成功能，由指定路径生成模式调整为下载模式，更方便复杂场景 ([7792cd3](https://github.com/Charles7c/continew-admin-ui-arco/commit/7792cd398f6c4a2d10187cb548ba687dc8f62c84))

 ## v2.4.0 (2024-02-16)

 ### ✨ 新特性

-* 系统日志详情新增 traceId 链路号显示 ([7359823](https://github.com/Charles7c/continew-admin-ui/commit/735982373a13889340970623bce544dafc574cdb))
+* 系统日志详情新增 traceId 链路号显示 ([7359823](https://github.com/Charles7c/continew-admin-ui-arco/commit/735982373a13889340970623bce544dafc574cdb))

 ### 💎 功能优化

- 取消用户默认密码，改为表单填写密码 ([e519d74](https://github.com/Charles7c/continew-admin-ui/commit/e519d746c92596d0b4a568aef26218b8c4c1e4f4)) ([dd1127e](https://github.com/Charles7c/continew-admin-ui/commit/dd1127e2b8ddfad70e67fca5502505fb269236cc))
- 部分 ID 列 => 序号列 ([678aa92](https://github.com/Charles7c/continew-admin-ui/commit/678aa92457dc172a300e78e9523ab0fe50715947))
+- 取消用户默认密码，改为表单填写密码 ([e519d74](https://github.com/Charles7c/continew-admin-ui-arco/commit/e519d746c92596d0b4a568aef26218b8c4c1e4f4)) ([dd1127e](https://github.com/Charles7c/continew-admin-ui-arco/commit/dd1127e2b8ddfad70e67fca5502505fb269236cc))
+- 部分 ID 列 => 序号列 ([678aa92](https://github.com/Charles7c/continew-admin-ui-arco/commit/678aa92457dc172a300e78e9523ab0fe50715947))

 ### 🐛 问题修复

- 修复暗黑模式下返回到登录页面时的部分样式错乱 ([65e564d](https://github.com/Charles7c/continew-admin-ui/commit/65e564dc67c06a18bc543d032d430718ae620cb9))
+- 修复暗黑模式下返回到登录页面时的部分样式错乱 ([65e564d](https://github.com/Charles7c/continew-admin-ui-arco/commit/65e564dc67c06a18bc543d032d430718ae620cb9))

 ## v2.3.0 (2024-01-21)

 ### ✨ 新特性

-* 引入 unplugin-auto-import，减少重复性 Vue 函数引入 ([b56f029](https://github.com/Charles7c/continew-admin-ui/commit/b56f029e680dc86f8bba174d80ef90ed11f9f25c))
+* 引入 unplugin-auto-import，减少重复性 Vue 函数引入 ([b56f029](https://github.com/Charles7c/continew-admin-ui-arco/commit/b56f029e680dc86f8bba174d80ef90ed11f9f25c))

 ### 💎 功能优化

- 优化部分弹窗提示 ([74b03bc](https://github.com/Charles7c/continew-admin-ui/commit/74b03bc3f62e90e987ff9b1a72fedaa903f85b1e))
- 优化部分字段名称 ([b2aa711](https://github.com/Charles7c/continew-admin-ui/commit/b2aa7114bca66c7c9ab9e71a7f757390cf2a4e54))
- ESLint 配置语义化 ([cd34761](https://github.com/Charles7c/continew-admin-ui/commit/cd3476107ef69f0889473abee416db3ad29701e7))
- 调整 Vue 组件内 script 标签到 template 标签之前 ([01dd38f](https://github.com/Charles7c/continew-admin-ui/commit/01dd38f8abccf5d88d8cd0d73df438f3389de7f7))
+- 优化部分弹窗提示 ([74b03bc](https://github.com/Charles7c/continew-admin-ui-arco/commit/74b03bc3f62e90e987ff9b1a72fedaa903f85b1e))
+- 优化部分字段名称 ([b2aa711](https://github.com/Charles7c/continew-admin-ui-arco/commit/b2aa7114bca66c7c9ab9e71a7f757390cf2a4e54))
+- ESLint 配置语义化 ([cd34761](https://github.com/Charles7c/continew-admin-ui-arco/commit/cd3476107ef69f0889473abee416db3ad29701e7))
+- 调整 Vue 组件内 script 标签到 template 标签之前 ([01dd38f](https://github.com/Charles7c/continew-admin-ui-arco/commit/01dd38f8abccf5d88d8cd0d73df438f3389de7f7))

 ### 🐛 问题修复

- 修复 fieldset 在暗黑模式的样式问题 ([470fad3](https://github.com/Charles7c/continew-admin-ui/commit/470fad3a0bfd3fbd343252a49078b28b779d1be5))
+- 修复 fieldset 在暗黑模式的样式问题 ([470fad3](https://github.com/Charles7c/continew-admin-ui-arco/commit/470fad3a0bfd3fbd343252a49078b28b779d1be5))
--- a/README.md
+++ b/README.md
@@ -1,9 +1,9 @@
 # ContiNew Admin UI

-<a href="https://github.com/Charles7c/continew-admin-ui/blob/dev/LICENSE" target="_blank">
+<a href="https://github.com/Charles7c/continew-admin-ui-arco/blob/dev/LICENSE" target="_blank">
 <img src="https://img.shields.io/badge/License-Apache--2.0-blue.svg" alt="License" />
 </a>
-<a href="https://github.com/Charles7c/continew-admin-ui" target="_blank">
+<a href="https://github.com/Charles7c/continew-admin-ui-arco" target="_blank">
 <img src="https://img.shields.io/badge/RELEASE-v2.5.0-%23ff3f59.svg" alt="Release" />
 </a>
 <a href="https://cn.vuejs.org/" target="_blank">
@@ -33,6 +33,8 @@

 📚 [在线文档](https://doc.charles7c.top) | 🚀 [演示地址](https://cnadmin.charles7c.top)（账号/密码：admin/admin123）

+> 全新 3.0 已经发布，点击[前往](https://gitee.com/continew/continew-admin-ui)
+
 ## 简介

 ContiNew Admin（Continue New Admin）持续迭代优化的前后端分离中后台管理系统框架。开箱即用，持续提供舒适的开发体验，依托开源协作模式，提升技术透明度、放大集体智慧、共创优秀实践，源源不断地为企业级项目开发提供助力。
@@ -59,10 +61,11 @@ ContiNew Admin（Continue New Admin）持续迭代优化的前后端分离中后

 ## 项目源码

-|       | 前端源码                                   | 后端源码                                |
-| ----- | -------------------------------------------- | ----------------------------------------- |
-| GitHub | [github.com/Charles7c/continew-admin-ui](https://github.com/Charles7c/continew-admin-ui) | [github.com/Charles7c/continew-admin](https://github.com/Charles7c/continew-admin) |
-| Gitee | [gitee.com/Charles7c/continew-admin-ui](https://gitee.com/Charles7c/continew-admin-ui) | [gitee.com/Charles7c/continew-admin](https://gitee.com/Charles7c/continew-admin) |
+|            | Gitee                                                                                     | GitHub                                                                             |
+|------------|-------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|
+| 前端         | [gitee.com/continew/continew-admin-ui-arco](https://gitee.com/continew/continew-admin-ui-arco) | [github.com/Charles7c/continew-admin-ui-arco](https://github.com/Charles7c/continew-admin-ui-arco-arco) |
+| 后端         | [gitee.com/continew/continew-admin](https://gitee.com/continew/continew-admin)            | [github.com/Charles7c/continew-admin](https://github.com/Charles7c/continew-admin)     |
+| **3.0 前端** | [gitee.com/continew/continew-admin-ui](https://gitee.com/continew/continew-admin-ui)      | [github.com/Charles7c/continew-admin-ui](https://github.com/Charles7c/continew-admin-ui-arco) |

 ##  系统功能

@@ -281,7 +284,7 @@ ContiNew Admin 的分支目前分为下个大版本的开发分支和上个大
 2. 然后，将 fork 过来的项目（即您的项目）克隆到本地
 3. 切换到当前仍在维护的分支（请务必充分了解分支使用说明，可进群联系维护者确认）
 4. 开始修改代码，修改完成后，将代码 commit 并 push 到您的远程仓库
-5. 在 Gitee 或 Github 上新建 pull request（pr），选择好源和目标，按模板要求填写说明信息后提交即可（多多参考 [已批准合并的 pr 记录](https://github.com/Charles7c/continew-admin-ui/pulls?q=is%3Apr+is%3Amerged)，会大大增加批准合并率）
+5. 在 Gitee 或 Github 上新建 pull request（pr），选择好源和目标，按模板要求填写说明信息后提交即可（多多参考 [已批准合并的 pr 记录](https://github.com/Charles7c/continew-admin-ui-arco/pulls?q=is%3Apr+is%3Amerged)，会大大增加批准合并率）
 6. 最后，耐心等待维护者合并您的请求即可

 请记住，如果您有任何疑问或需要帮助，我们将随时提供支持。
@@ -308,7 +311,7 @@ ContiNew Admin 的分支目前分为下个大版本的开发分支和上个大
 </div>
 <details>
 <summary>无加群意愿</summary>
-如无加群意愿，欢迎在 <a href="https://github.com/Charles7c/continew-admin-ui/issues" target="_blank">Issues</a> 中反馈交流~ 🍻
+如无加群意愿，欢迎在 <a href="https://github.com/Charles7c/continew-admin-ui-arco/issues" target="_blank">Issues</a> 中反馈交流~ 🍻
 </details>

 ## 鸣谢
@@ -331,5 +334,5 @@ ContiNew Admin 的分支目前分为下个大版本的开发分支和上个大

 ## License

- 遵循 <a href="https://github.com/Charles7c/continew-admin-ui/blob/dev/LICENSE" target="_blank">Apache-2.0</a> 开源许可协议
+- 遵循 <a href="https://github.com/Charles7c/continew-admin-ui-arco/blob/dev/LICENSE" target="_blank">Apache-2.0</a> 开源许可协议
 - Copyright © 2022-present <a href="https://blog.charles7c.top" target="_blank">Charles7c</a>
--- a/config/plugin/imageOptimizer.ts
+++ b/config/plugin/imageOptimizer.ts
@@ -1,11 +0,0 @@
-/**
- * Image resource files used to compress the output of the production environment
- * 图片压缩
- * https://www.npmjs.com/package/vite-plugin-image-optimizer
- */
-import { ViteImageOptimizer } from 'vite-plugin-image-optimizer';
-
-export default function configImageOptimizerPlugin() {
-  const imageOptimizerPlugin = ViteImageOptimizer();
-  return imageOptimizerPlugin;
-}
--- a/config/plugin/imagemin.ts
+++ b/config/plugin/imagemin.ts
@@ -0,0 +1,37 @@
+/**
+ * Image resource files used to compress the output of the production environment
+ * 图片压缩
+ * https://github.com/anncwb/vite-plugin-imagemin
+ */
+import viteImagemin from 'vite-plugin-imagemin';
+
+export default function configImageminPlugin() {
+  const imageminPlugin = viteImagemin({
+    gifsicle: {
+      optimizationLevel: 7,
+      interlaced: false,
+    },
+    optipng: {
+      optimizationLevel: 7,
+    },
+    mozjpeg: {
+      quality: 20,
+    },
+    pngquant: {
+      quality: [0.8, 0.9],
+      speed: 4,
+    },
+    svgo: {
+      plugins: [
+        {
+          name: 'removeViewBox',
+        },
+        {
+          name: 'removeEmptyAttrs',
+          active: false,
+        },
+      ],
+    },
+  });
+  return imageminPlugin;
+}
--- a/config/vite.config.prod.ts
+++ b/config/vite.config.prod.ts
@@ -3,7 +3,7 @@ import baseConfig from './vite.config.base';
 import configCompressPlugin from './plugin/compress';
 import configVisualizerPlugin from './plugin/visualizer';
 // import configArcoResolverPlugin from './plugin/arcoResolver';
-import configImageOptimizerPlugin from './plugin/imageOptimizer';
+import configImageminPlugin from './plugin/imagemin';
 import createSvgIcon from './plugin/svg-icon';

 export default mergeConfig(
@@ -13,7 +13,7 @@ export default mergeConfig(
      configCompressPlugin('gzip'),
      configVisualizerPlugin(),
      // configArcoResolverPlugin(),
-      configImageOptimizerPlugin(),
+      configImageminPlugin(),
      createSvgIcon(true),
    ],
    build: {
@@ -29,5 +29,5 @@ export default mergeConfig(
      chunkSizeWarningLimit: 2000,
    },
  },
-  baseConfig,
+  baseConfig
 );
--- a/package.json
+++ b/package.json
@@ -46,7 +46,6 @@
    "mitt": "^3.0.1",
    "nprogress": "^0.2.0",
    "pinia": "^2.1.7",
-    "pinia-plugin-persistedstate": "^3.2.1",
    "query-string": "^8.1.0",
    "sortablejs": "^1.15.1",
    "v-viewer": "^3.0.10",
@@ -92,21 +91,19 @@
    "rollup": "^4.9.1",
    "rollup-plugin-visualizer": "^5.11.0",
    "sass": "^1.69.5",
-    "sharp": "^0.33.3",
    "stylelint": "^16.0.2",
    "stylelint-config-prettier": "^9.0.5",
    "stylelint-config-rational-order": "^0.1.2",
    "stylelint-config-recommended-vue": "^1.5.0",
    "stylelint-config-standard": "^35.0.0",
    "stylelint-order": "^6.0.4",
-    "svgo": "^3.2.0",
    "typescript": "^5.3.3",
    "unplugin-auto-import": "^0.17.3",
    "unplugin-vue-components": "^0.26.0",
    "vite": "^4.5.1",
    "vite-plugin-compression": "^0.5.1",
    "vite-plugin-eslint": "^1.8.1",
-    "vite-plugin-image-optimizer": "^1.1.7",
+    "vite-plugin-imagemin": "^0.6.1",
    "vite-plugin-svg-icons": "^2.0.1",
    "vite-svg-loader": "^4.0.0",
    "vue-tsc": "^1.8.26"
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
--- a/src/store/index.ts
+++ b/src/store/index.ts
@@ -1,11 +1,10 @@
 import { createPinia } from 'pinia';
-import piniaPluginPersistedstate from 'pinia-plugin-persistedstate';
 import useAppStore from './modules/app';
 import useUserStore from './modules/user';
 import useDictStore from './modules/dict';
 import useTabBarStore from './modules/tab-bar';

 const pinia = createPinia();
-pinia.use(piniaPluginPersistedstate);
+
 export { useAppStore, useUserStore, useDictStore, useTabBarStore };
 export default pinia;
--- a/src/store/modules/app/index.ts
+++ b/src/store/modules/app/index.ts
@@ -27,6 +27,7 @@ const recursionMenu = (
 };
 const useAppStore = defineStore('app', {
  state: (): AppState => ({ ...defaultSettings, config: {} }),
+
  getters: {
    appCurrentSetting(state: AppState): AppState {
      return { ...state };
@@ -154,7 +155,6 @@ const useAppStore = defineStore('app', {
        );
    },
  },
-  persist: true,
 });

 export default useAppStore;
--- a/src/views/demo/visualization/multi-dimension-data-analysis/components/data-overview.vue
+++ b/src/views/demo/visualization/multi-dimension-data-analysis/components/data-overview.vue
@@ -51,7 +51,7 @@
            el.color
          }" class="tooltip-item-icon"></span><span>${el.seriesName}</span>
        </p>
-        <span class="tooltip-value">${el.toLocaleString()}</span>
+        <span class="tooltip-value">${el.value.toLocaleString()}</span>
      </div>`
      )
      .reverse()
Author	SHA1	Message	Date
Charles7c	9eab97b1c0	docs: 更新 README 文档	2024-04-28 22:12:02 +08:00
Charles7c	3d528795ff	docs: 更新 README 文档	2024-04-24 22:45:23 +08:00