fmt/README.md

fmt

介绍

fmt 是一个基于 Spring Boot 的文件管理工具，旨在提供便捷的文件上传、下载、打包、删除等操作。它结合了简洁的前端界面与强大的后端功能，适用于需要进行文件管理的各类应用场景。

软件架构

本项目采用前后端一体化架构，后端基于 Spring Boot 框架，使用 Java 语言开发，前端采用 HTML、CSS 和 JavaScript 技术，结合 axui 框架进行界面渲染。主要模块包括：

• 文件上传模块：支持文件上传并保存至服务器。
• 文件下载模块：支持文件下载及 ZIP 打包下载。
• 文件管理模块：支持文件删除、批量删除等操作。
• 日志模块：实时推送日志信息。
• WebSocket 模块：用于前后端实时通信。
• 工具类模块：包括 MD5 工具、操作系统工具等。

安装教程

1. 克隆项目：

   git clone https://gitee.com/thzxx/fmt.git
   

2. 构建项目： 使用 Maven 构建项目：

   cd fmt
   mvn clean package
   

3. 运行项目： 启动 Spring Boot 应用：

   java -jar target/fmt.jar
   

4. 访问项目： 打开浏览器访问：

   http://localhost:8080
   

使用说明

• 上传文件： 访问 /upload/index 页面，选择文件进行上传。

• 下载文件： 访问 /download/index 页面，点击文件进行下载，或使用 /download/file 接口下载指定路径文件。

• 打包下载： 使用 /download/packZip 接口，传入文件名列表进行 ZIP 打包下载。

• 删除文件： 使用 /download/delete 或 /download/batchDel 接口进行单个或批量删除。

• 查看日志： 访问 /logging/index 页面，实时查看日志信息。

• WebSocket 实时通信： 前端通过 WebSocket 连接 /ws，接收服务器推送的消息。

参与贡献

欢迎贡献代码和改进项目。请遵循以下步骤：

1. Fork 项目。
2. 创建新分支。
3. 提交代码。
4. 创建 Pull Request。

如发现 Bug 或有改进建议，请提交 Issue 或直接联系项目维护者。

许可证

本项目采用 MIT 许可证。详情请查看项目根目录下的 LICENSE 文件。