# fkl-admin-front **Repository Path**: feng-kailong/fkl-admin-front ## Basic Information - **Project Name**: fkl-admin-front - **Description**: fkl-admin企业级后台管理系统-前端代码 - **Primary Language**: HTML/CSS - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 2 - **Forks**: 0 - **Created**: 2025-12-02 - **Last Updated**: 2025-12-02 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # fkl-admin 后台管理系统 一个基于 Vue 3 + TypeScript + Ant Design Vue 的现代化企业级后台管理系统前端项目。 ## 📋 项目简介 fkl-admin 是一个功能完善的后台管理系统前端解决方案,采用最新的前端技术栈,提供丰富的业务功能模块,支持动态路由、权限控制、实时消息通知等企业级特性。 ## ✨ 核心特性 ### 🔐 认证与权限 - **Token 认证**: 基于 satoken 的认证机制 - **路由守卫**: 自动拦截未授权访问 - **动态路由**: 根据用户权限动态加载路由 - **菜单权限**: 基于角色的菜单权限控制 ### 💬 实时通信 - **WebSocket 集成**: 实时消息推送 - **系统通知**: 支持站内通知、待办事项 - **消息管理**: 站内信、通知、待办一体化管理 ### 🎨 用户体验 - **响应式布局**: 适配不同屏幕尺寸 - **侧边栏折叠**: 灵活的布局控制 - **全屏模式**: 支持内容区域全屏显示 - **智能时间显示**: 友好的时间格式化(如"5分钟前") ### 🛠️ 开发体验 - **TypeScript**: 完整的类型支持 - **组件化开发**: 可复用的组件体系 - **状态管理**: Pinia 状态管理,支持持久化 - **代码规范**: 统一的代码风格和结构 ## 🚀 技术栈 ### 核心框架 - **Vue 3.5.17** - 渐进式 JavaScript 框架 - **TypeScript 5.8** - 类型安全的 JavaScript - **Vite 7.0** - 下一代前端构建工具 ### UI 组件库 - **Ant Design Vue 4.2.6** - 企业级 UI 组件库 - **@ant-design/icons-vue 7.0.1** - 图标库 ### 状态管理 - **Pinia 3.0.3** - Vue 官方状态管理库 - **pinia-plugin-persistedstate 4.4.1** - 状态持久化插件 ### 路由管理 - **Vue Router 4.5.1** - 官方路由管理器 ### HTTP 请求 - **Axios 1.10.0** - 基于 Promise 的 HTTP 客户端 ### 工具库 - **dayjs 1.11.13** - 轻量级日期处理库 - **fabric 5.5.2** - Canvas 图形库 - **file-saver 2.0.5** - 文件保存工具 - **uuid 11.1.0** - UUID 生成器 - **@amap/amap-jsapi-loader 1.0.1** - 高德地图 API ## 📦 功能模块 ### 1. 系统管理 - **用户管理**: 用户列表、新增、编辑、删除、密码重置、数据导出 - **角色管理**: 角色配置与权限分配 - **菜单管理**: 动态菜单配置、树形结构管理、菜单导出 ### 2. DevOps 管理 - **流水线管理**: 流水线列表、创建、编辑、删除、复制、运行 - **流水线详情**: 详情查看、历史记录、日志查看、文件下载、回滚 - **模板管理**: 流水线模板配置与管理 - **日志管理**: 运行日志查看与分析 ### 3. 审批流程 - **自定义审批**: 审批流程自定义配置 - **审批申请**: 审批申请提交与管理 - **审批处理**: 审批任务处理与流转 ### 4. 考勤管理 - **打卡管理**: 打卡记录查看与管理 - **考勤统计**: 考勤数据统计与分析 ### 5. 请假管理 - **请假申请**: 请假申请提交 - **请假审批**: 请假审批处理 - **请假记录**: 请假历史记录查看 ### 6. 消息中心 - **站内信**: 用户间消息通信 - **系统通知**: 系统通知接收与确认 - **待办事项**: 待办任务管理 ### 7. 文件管理 - **文件上传**: 支持文件上传功能 - **文件管理**: 文件列表、下载、删除 ### 8. 共享空间 - **共享文件**: 文件共享与管理 - **操作日志**: 共享空间操作日志 ### 9. 日志管理 - **系统日志**: 系统操作日志查看 ## 📁 项目结构 ``` fkl-admin/ ├── public/ # 静态资源 │ ├── config/ # 配置文件 │ └── img/ # 图片资源 ├── src/ │ ├── api/ # API 接口层 │ │ ├── approvalCustom.ts │ │ ├── approvalCustomApplication.ts │ │ ├── approvalCustomApproval.ts │ │ ├── checkIn.ts │ │ ├── common.ts │ │ ├── commonConfig.ts │ │ ├── devopsLog.ts │ │ ├── devopsPipeline.ts │ │ ├── devopsTemplate.ts │ │ ├── file.ts │ │ ├── leave.ts │ │ ├── menus.ts │ │ ├── message.ts │ │ ├── roles.ts │ │ ├── shareSpace.ts │ │ ├── users.ts │ │ └── userSetting.ts │ ├── assets/ # 资源文件 │ │ └── common.css # 全局样式 │ ├── components/ # 公共组件 │ │ ├── dashboard/ # 仪表盘组件 │ │ │ ├── menus.vue # 侧边栏菜单 │ │ │ └── topBar.vue # 顶部导航栏 │ │ ├── leave/ # 请假组件 │ │ ├── log/ # 日志组件 │ │ ├── message/ # 消息组件 │ │ └── system/ # 系统组件 │ ├── router/ # 路由配置 │ │ └── index.ts # 路由定义 │ ├── stores/ # Pinia 状态管理 │ │ ├── common.ts # 通用状态 │ │ ├── menus.ts # 菜单状态 │ │ └── users.ts # 用户状态 │ ├── types/ # TypeScript 类型定义 │ │ ├── response.ts # 响应类型 │ │ └── user.ts # 用户类型 │ ├── utils/ # 工具函数 │ │ ├── icon.ts # 图标注册 │ │ ├── request.ts # HTTP 请求封装 │ │ └── time.ts # 时间格式化 │ ├── views/ # 页面视图 │ │ ├── home/ # 首页 │ │ ├── login/ # 登录页 │ │ ├── register/ # 注册页 │ │ └── system/ # 系统管理页面 │ │ ├── approval/ # 审批管理 │ │ ├── approvalCustom/ # 自定义审批 │ │ ├── attendance/ # 考勤管理 │ │ ├── checkIn/ # 打卡管理 │ │ ├── devops/ # DevOps 管理 │ │ ├── devopsDetail/ # DevOps 详情 │ │ ├── devopsTemplate/ # DevOps 模板 │ │ ├── file/ # 文件管理 │ │ ├── homeIndex/ # 系统首页 │ │ ├── leave/ # 请假管理 │ │ ├── log/ # 日志管理 │ │ ├── menu/ # 菜单管理 │ │ ├── message/ # 消息中心 │ │ ├── roles/ # 角色管理 │ │ ├── shareSpace/ # 共享空间 │ │ └── user/ # 用户管理 │ ├── App.vue # 根组件 │ └── main.ts # 入口文件 ├── index.html # HTML 模板 ├── package.json # 项目配置 ├── tsconfig.json # TypeScript 配置 ├── vite.config.ts # Vite 配置 └── README.md # 项目说明 ``` ## 🏃 快速开始 ### 环境要求 - Node.js >= 18.0.0 - npm >= 9.0.0 或 yarn >= 1.22.0 ### 安装依赖 ```bash npm install ``` ### 开发运行 ```bash npm run dev ``` 项目将在 `http://localhost:5173` 启动,并自动打开浏览器。 ### 构建生产版本 ```bash npm run build ``` ### 类型检查 ```bash npm run type-check ``` ### 预览生产构建 ```bash npm run preview ``` ## ⚙️ 配置说明 ### 环境变量 项目支持通过 `.env` 文件配置环境变量: - `VITE_APP_BASE_API`: API 基础路径(默认: `/api/v1`) ### 代理配置 开发环境下的 API 代理配置在 `vite.config.ts` 中: ```typescript server: { port: 5173, proxy: { '/api/v1': { target: 'http://localhost:8000', changeOrigin: true, } } } ``` ### WebSocket 配置 WebSocket 连接地址在 `src/views/home/index.vue` 中配置: ```typescript const wsUrl = "ws://127.0.0.1:8000/api/v1/websocket/notice/" + token ``` ## 🔧 核心功能说明 ### 动态路由 系统支持根据后端返回的菜单数据动态加载路由: ```typescript // 在 App.vue 中动态添加路由 const addRouterData = () => { const modules = import.meta.glob("@/views/system/**/*.vue"); const dynamicRoutes = menusStore.dataList .filter((x: any) => x.component) .map((x: any) => ({ path: x.path, name: x.menuName, component: modules[`/src/views/system${x.component}`], meta: { keepAlive: true } })); dynamicRoutes.forEach((route) => { router.addRoute("home", route); }); }; ``` ### 请求拦截 所有 HTTP 请求都会自动添加 Token: ```typescript request.interceptors.request.use((config) => { const token = useUserStore().token; if (token && !directList.includes(config.url)) { config.headers['satoken'] = token; } return config; }); ``` ### 响应拦截 统一处理 API 响应和错误: ```typescript request.interceptors.response.use( (response) => { const res = response.data; if (res.code === 200) { return res.data; } // 处理错误码 if (res.code === 401) { // Token 过期,跳转登录 } return Promise.reject(new Error(res.message)); } ); ``` ## 📝 开发指南 ### 添加新的 API 接口 1. 在 `src/api/` 目录下创建或编辑对应的 API 文件 2. 使用统一的 `request` 工具发送请求 3. 定义对应的 TypeScript 类型 示例: ```typescript import request from '@/utils/request.ts' import type { ResponseResult } from '@/types/response' export function getDataList(params: any) { return request({ url: '/api/data/list', method: 'post', data: params }) } ``` ### 添加新的页面 1. 在 `src/views/system/` 下创建页面组件 2. 确保组件路径与后端菜单配置的 `component` 字段匹配 3. 页面会自动通过动态路由加载 ### 使用状态管理 ```typescript import { useUserStore } from '@/stores/users' const userStore = useUserStore() // 设置 token userStore.setToken('your-token') // 获取 token const token = userStore.token ``` ### 时间格式化 使用工具函数格式化时间: ```typescript import { formatTime, formatDate, formatTimeOnly } from '@/utils/time' // 智能时间显示(如"5分钟前") const timeStr = formatTime(timestamp) // 仅日期 const dateStr = formatDate(timestamp) // 仅时间 const timeOnlyStr = formatTimeOnly(timestamp) ``` ## 🐛 常见问题 ### 1. 跨域问题 确保 `vite.config.ts` 中的代理配置正确,后端服务运行在 `http://localhost:8000`。 ### 2. Token 过期 系统会自动检测 Token 过期(401 错误),并跳转到登录页。 ### 3. 路由不生效 检查菜单数据中的 `component` 字段是否正确,确保对应的 Vue 组件文件存在。 ### 4. WebSocket 连接失败 检查 WebSocket 服务地址和端口是否正确,确保后端 WebSocket 服务正常运行。 ## 📄 许可证 本项目为私有项目。 ## 👥 贡献 欢迎提交 Issue 和 Pull Request。 ## 📮 联系方式 如有问题或建议,请联系项目维护者。 --- **注意**: 本项目需要配合后端 API 服务使用,请确保后端服务正常运行。