From 5b8eb589844f6bc38ce9b9d0d125c1989ac62bb9 Mon Sep 17 00:00:00 2001
From: liyating <2435065796@qq.com>
Date: Thu, 2 Dec 2021 15:32:42 +0800
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=83=20docs(README):=20=E6=9B=B4?=
=?UTF-8?q?=E6=96=B0=20README?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
README.en.md | 245 ---------------------------------------------------
README.md | 230 +++++++++++++++++++++++++++++++----------------
2 files changed, 152 insertions(+), 323 deletions(-)
delete mode 100644 README.en.md
diff --git a/README.en.md b/README.en.md
deleted file mode 100644
index 3cd9844..0000000
--- a/README.en.md
+++ /dev/null
@@ -1,245 +0,0 @@
-
-
-
-
- The distributed file system based on Spring Boot + VUE CLI@3 framework is designed to provide a simple and convenient file storage scheme for users and enterprises. It can manage files with a perfect directory structure system.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Online presentation environment |
- Installation instructions |
- Documentation |
- Course links |
- Update log
-
-
----
-
-## Open source that
-
-System 100% open source
-The software follows the MIT open source protocol
-
-**You can build on it to improve its functionality and become a contributor to this project**
-
-**You can also use this project as a scaffold for other projects**
-
-## Function is introduced
-
-### The user action
-
-1. User login and registration
-
-### File operations
-
-1. Users can add, delete and modify the directory structure
-2. Provide drag and drop to upload and downloading of files, support screenshot paste directly upload pictures
-3. Support online decompression of ZIP files and RAR files
-4. Support files and directories to move and copy
-5. Classified view of multiple file formats
-6. Support AliCloud OSS object storage and FastDFS storage
-7. Added sharding uploading, which supports local storage, Ali Cloud OSS and FastDFS
-8. Support high speed second transmission function to improve uploading efficiency
-9. The foreground of uploading files displays the progress, rate, percentage and other information of uploading files in real time
-10. Support file renaming
-11. Display file storage and total capacity in real time
-12. Support ElasticSearch file search
-13. Support to share files with others and view the list of files you have shared
-14. Provide picture online preview, video online preview, audio online preview, PDF, JSON, TXT and other commonly used text file online preview, support Office online preview
-15. ……
-
-## The source address
-
-| The project name | The source address |
-| ---------------------- | -------------------------------------------------------------------------------------------- |
-| The front project | [https://gitee.com/qiwen-cloud/qiwen-file-web](https://gitee.com/qiwen-cloud/qiwen-file-web) |
-| The background project | [https://gitee.com/qiwen-cloud/qiwen-file](https://gitee.com/qiwen-cloud/qiwen-file) |
-
-## Network topology
-
-
-
-## Software architecture
-
-The project was developed and deployed in a front-end separation approach, using the following key technologies
-
-**Front**:Element UI、Vue CLI@3、Node.js、Webpack
-
-**Background **:Spring Boot、MyBatis、JPA、JWT
-
-**Database** : MySQL
-
-**Data Structure**:Recursive algorithms, tree traversal and insertion...
-
-## Directions for use
-
-1、This project is the back-end code
-
-2、Download the front-end code, you can access the address to pull:[qiwen-file-web](https://gitee.com/qiwen-cloud/qiwen-file-web)
-
-## Deployment instructions
-
-Please move to Qiwenshare [手把手教你部署奇文网盘](https://www.qiwenshare.com/essay/detail/169)
-
-## Screenshots of some functions
-
-### 1. The cloud home page
-
-#### 1.1 The page layout
-
-- Left menu bar area: display file type, click to view files by category, the bottom shows the occupied storage space.
-- Top file operation area: including operation button group for files, switch button group for file viewing mode, and set button for file display column.
-- Right file display area: including breadcrumb navigation bar -- identifies the directory currently located; File display area -- the display format will change according to the file viewing mode; Bottom paging component.
-
-
-
-#### 1.2 Layout adjustment function
-
-The left menu bar is collapsible, and the table operation column is collapsible. You can control the display and hiding of the columns in the current table.
-
-
-
-#### 1.3 Batch operation function
-
-
-
-### 2. Three viewing modes
-
-File viewing supports three presentation modes (list, grid, and timeline)
-
-#### 2.1 List Mode
-
-
-
-#### 2.2 Grid Mode
-
-
-
-#### 2.3 Timeline Mode
-
-
-
-### 3. Create a folder
-
-
-
-### 4. File icon resize
-
-Manual resizing of ICONS is supported in grid mode and timeline mode:
-
-
-
-### 5. Move files
-
-
-
-### 6. Online file decompression
-
-
-
-### 7. There are three ways to upload files
-
-#### 7.1 File fragmentation upload
-
-文件采用**分片上传**,集成了[simiple-uplader](https://github.com/simple-uploader/Uploader/blob/develop/README_zh-CN.md#uploader)的文件**秒传**、**断点续传**功能。
-
-
-#### 7.2 Drag and drop uploads
-
-
-
-#### 7.3 Paste and upload the screenshot
-
-After taking the screenshot directly with any screenshot tool, use Ctrl + V to paste the image in the drag and drop area and click Upload to upload the image.
-
-
-
-### 8. Document Recycle Bin
-
-
-
-### 9. Files are shared individually and in batches
-
-1. Support single and batch file sharing to others:
-
- 
-
-2. You can select the expiration time and whether you want to extract the code:
-
- 
-
-3. Provide quick copy link and extract code to others:
-
- 
-
- Paste sharing link and extract code effect:
-
- ```
- 分享链接:https://pan.qiwenshare.com/share/27d9b438019e4f68bcec02f579d163b7
- 提取码:356978
- 复制链接到浏览器中并输入提取码即可查看文件
- ```
-
-4. Others view the shared content, and support the function of saving to network disk:
-
-
-
-### 10. Support to view the list of files you have shared
-
-Support quick copy of the sharing link and extraction code in the list, and mark the sharing time and expiration status:
-
-
-
-### 11. Video Preview Online
-
-When the file type is video, click to open the preview window and display the playlist. It supports fast forward, backward, pause, double speed playback, full-screen playback, download video and fold playlist.
-
-
-
-### 12. Audio online playback
-
-
-
-## Contact us
-
-If you have any questions, please join the QQ group consultation
-
-**QQ communication group ** and **WeChat public account** please scan the following QR code
-
-
-

-

-
-
-## Thanks
-
-The development of this project cannot be achieved without the support of other excellent open source projects. I would like to thank the following open source projects:
-
-- [vue-simple-uploader](https://github.com/simple-uploader/vue-uploader/blob/master/README_zh-CN.md):A [simple-uploader.js](https://github.com/simple-uploader/Uploader/blob/develop/README_zh-CN.md) based on the development of Vue.js for the sharding upload plug-in
-- [vue-video-player](https://github.com/surmon-china/vue-video-player):A video player component based on [video.js](https://docs.videojs.com/) development
-
-## Participate in the contribution
-
-1. Fork the warehouse
-2. Create a new branch: Feat_xxx
-3. Submit code
-4. Create a new Pull Request
-
-## Gitee Special Effects
-
-1. Use Readme_XXX.md to support different languages,for example: Readme_en.md,Readme_zh.md
-2. The official blog of Gitee: [blog.gitee.com](https://blog.gitee.com)
-3. You can be in [https://gitee.com/explore](https://gitee.com/explore) here to decode the cloud good open source project
-4. [GVP](https://gitee.com/gvp) The full name is the most valuable open source project of Gitee, and the excellent open source project comprehensively evaluated by Gitee
-5. The Gitee official user's manual: [https://gitee.com/help](https://gitee.com/help)
-6. The Gitee cover figure is a column used to show the elegant demeanor of Code Cloud members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
diff --git a/README.md b/README.md
index 71dfe0f..1620469 100644
--- a/README.md
+++ b/README.md
@@ -39,25 +39,38 @@
### 用户操作
-1. 用户的登录和注册
+1. 用户注册
+1. 用户登录
-### 文件操作
+### 基本文件操作
-1. 用户可对目录结构进行增加,删除,修改
-2. 提供文件的拖拽上传,下载,支持截图粘贴直接上传图片
-3. 支持对 zip 文件和 rar 文件的在线解压缩
-4. 支持文件和目录的移动和复制
-5. 多文件格式分类查看
-6. 支持阿里云 OSS 对象存储,FastDFS 存储
-7. 增加分片上传,该功能同时支持本地存储和阿里云 OSS,FastDFS
-8. 支持极速秒传功能,提高上传效率
-9. 上传文件前台实时显示上传文件进度,上传速率,百分比等信息
-10. 支持文件重命名
-11. 可实时显示文件存储占用情况及总占用容量
-12. 支持 ElasticSearch 文件搜索
-13. 支持将文件分享给他人,并查看自己已分享过的文件列表
-14. 提供图片在线预览、视频在线预览、音频在线预览、PDF、JSON、TXT 等常用文本文件在线预览,支持 office 在线预览
-15. ……
+| 操作 | 文件 | 文件夹 | 单个 | 批量 | 备注 |
+| :----- | :--: | :----: | :--: | :--: | ------------------------------------------------------------ |
+| 创建 | √ | √ | √ | ⚪ | 创建 Word、Excel、PowerPoint 在线文件 |
+| 删除 | √ | √ | √ | √ | |
+| 上传 | √ | √ | √ | √ | **拖拽**上传、**粘贴截图**上传 |
+| 重命名 | √ | √ | √ | ⚪ | |
+| 移动 | √ | √ | √ | √ | |
+| 复制 | √ | ⚪ | √ | ⚪ | |
+| 解压缩 | √ | ⚪ | √ | ⚪ | **ZIP、RAR** |
+| 预览 | √ | ⚪ | √ | ⚪ | 支持图片、视频、音频在线预览
支持PDF、JSON、TXT、HTML 等常用文本文件
支持 Office 文件在线预览 |
+| 分享 | √ | √ | √ | √ | 支持有效期、提取码 |
+| 搜索 | √ | √ | ⚪ | ⚪ | 支持 ElasticSearch 文件名称模糊搜索 |
+
+### 特色功能
+
+| 功能 | 描述 |
+| ------------ | ------------------------------------------------------------ |
+| 在线编辑功能 | Word、Excel、PowerPoint 文档的在线创建、**在线编辑**、协同编辑功能
集成 [OnlyOffice](https://api.onlyoffice.com/),安装方式参考 [安装 ONLYOFFICE](https://www.qiwenshare.com/essay/detail/1208) |
+| 文件分类查看 | 图片、视频、音乐、文档、其他,分类查看更快捷 |
+| 多种查看模式 | 支持网格模式、列表模式、时间线模式
网格模式下图标支持手动控制显示大小 |
+| 回收站 | 删除文件自动移入回收站,支持在回收站中彻底删除、还原文件 |
+| 多种存储方式 | 基于奇文社区自研框架 [UFOP](https://gitee.com/qiwen-cloud/ufop-spring-boot-starter),实现文件多样化存储。
支持**本地**磁盘、**阿里云 OSS** 对象存储、**FastDFS** 存储、**MinIO** 存储、
**七牛云 KODO** 对象存储,点击查看配置方式[存储方式配置](https://pan.qiwenshare.com/docs/config/#%E5%AD%98%E5%82%A8%E6%96%B9%E5%BC%8F%E9%85%8D%E7%BD%AE) |
+| 支持分片上传 | 基于奇文社区自研框架 [UFOP](https://gitee.com/qiwen-cloud/ufop-spring-boot-starter), 实现文件分片上传。
集成优秀开源项目 [vue-simple-uploader](https://github.com/simple-uploader/vue-uploader/blob/master/README_zh-CN.md) |
+| 支持极速秒传 | 计算文件 MD5,实现极速秒传效果,提高上传效率 |
+| 支持断点续传 | 同一个文件,当上传过程中网络中断,可以从断点处继续上传 |
+| 实时进度显示 | 页面实时显示上传文件进度、速度、结果等信息 |
+| 存储容量显示 | 可实时显示文件存储占用情况及总存储容量 |
## 源码地址
@@ -98,126 +111,187 @@
#### 1.1 页面布局
-- 左侧菜单栏区域:展示文件类型,点击可以分类查看文件,底部显示已占用存储空间。
-- 顶部文件操作区域:包括对文件的操作按钮组、文件查看模式切换按钮组、设置文件显示列按钮。
-- 右侧文件展示区域:包括面包屑导航栏——标识当前位于的目录;文件展示区域——展示形式会随文件查看模式而改变;底部分页组件。
+- 左侧分类栏区域:展示文件类型,分为我的文件、回收站和我的分享三大类,切换分类可以查看文件,底部显示已占用存储空间。
+ 1. 点击左侧分类栏中的**全部**,右侧文件列表会随面包屑导航栏中的当前位置变化而变化,调用后台接口,传参当前位置 & 分页数据,获取当前路径下 & 当前页的文件列表。
+ 2. 点击左侧分类栏中的**图片、文档、视频、音乐、其他**,面包屑导航栏将显示当前文件类型,右侧文件列表会随左侧分类栏的切换而变化,调用后台接口,传参当前点击的文件类型 & 分页数据,获取当前文件类型 & 当前页的文件列表。
+ 3. 点击左侧分类栏中的**回收站**,右侧文件列表显示回收站中的文件。
+ 4. 点击左侧分类栏中的**我的分享**,右侧文件列表显示个人分享过的文件。
+- 顶部文件操作区域:包括对文件的操作按钮组、文件查看模式切换按钮组、设置文件显示列按钮
+- 中间面包屑导航栏:标识当前位于的目录。点击层级,可以回到任意一层目录;**点击面包屑导航栏后面的空白处,可以手动输入路径以便快速进入指定目录**。
+- 右侧文件展示区域:展示形式会随文件查看模式而改变;底部分页组件。
-
+
#### 1.2 布局调整功能
-左侧菜单栏可折叠,表格操作列可折叠,可控制当前表格中列的显示和隐藏
+左侧菜单栏可折叠,可控制当前表格中列的显示和隐藏
-
+
-#### 1.3 批量操作功能
-
-
-
-### 2. 三种查看模式
-
-文件查看支持三种展示模式(列表、网格和时间线模式)
-
-#### 2.1 列表模式
-
-
-
-#### 2.2 网格模式
-
-
-
-#### 2.3 时间线模式
-
-
-
-### 3. 创建文件夹
-
-
-
-### 4. 文件图标大小调整
+#### 1.3 文件图标大小调整
在网格模式和时间线模式下,支持手动调整图标大小:
-
+
-### 5. 文件移动
+### 2. 路径导航
-
+点击目录跳转到该文件夹内部,在面包屑导航栏后面空白处点击,可以**输入路径**,快速到达指定路径(此功能仅支持在 **我的文件 - 全部** 分类下使用)
-### 6. 文件在线解压缩
+
-
+### 3. 三种查看模式
-### 7. 文件上传三种方式
+文件查看支持三种展示模式:列表、网格和时间线模式
-#### 7.1 文件分片上传
+#### 3.1 列表模式
-文件采用**分片上传**,集成了[simiple-uplader](https://github.com/simple-uploader/Uploader/blob/develop/README_zh-CN.md#uploader)的文件**秒传**、**断点续传**功能。
-
+
-#### 7.2 拖拽上传
+#### 3.2 网格模式
-
+
-#### 7.3 截图粘贴上传
+#### 3.3 时间线模式
+
+时间线模式目前仅在左侧分类栏选择图片时才支持,我们会尽快支持其他类型的文件
+
+
+
+### 4. 文件操作
+
+文件操作结合了电脑客户端的操作方式,支持任何文件右键唤起操作列表,或勾选文件并点击顶部相关批量操作按钮。
+
+#### 4.1 新建文件夹
+
+
+
+#### 4.2 文件移动
+
+支持文件单个和批量移动,选择目录后,点击确定即可移动文件到目标路径,同时在弹框中提供新建文件夹功能。
+
+
+
+#### 4.3 文件在线解压缩
+
+支持 ZIP 和 RAR 格式的文件在线解压缩,支持三种解压方式:
+
+1. 解压到当前文件夹
+2. 解压到以当前压缩文件命名的文件夹内
+3. 解压到指定文件夹
+
+
+
+#### 4.4 文件搜索
+
+支持文件名搜索文件,搜索功能后台配置请查看顶部导航栏`配置-后台项目配置-文件搜索配置`
+
+
+
+#### 4.5 批量操作功能
+
+在列表和网格模式下,提供了批量操作功能,可以对文件进行批量删除、移动和下载。
+
+
+
+### 5. 三种文件上传方式
+
+#### 5.1 文件 & 文件夹分片上传
+
+支持**文件**和**文件夹**上传。文件采用**分片上传**,集成了 [simiple-uplader](https://github.com/simple-uploader/Uploader/blob/develop/README_zh-CN.md#uploader) 的文件**秒传**、**断点续传**功能,此插件的具体配置项可以查看该项目的官方文档。
+
+
+#### 5.2 拖拽上传
+
+支持全屏区域拖拽上传文件。
+
+
+
+#### 5.3 截图粘贴上传
直接使用任何截图工具截图后,在拖拽区域使用 Ctrl + V 粘贴图片,点击上传图片即可上传。
-
+
-### 8. 文件回收站
+### 6. 文件回收站
-
+提供文件回收站功能,支持彻底删除和还原文件。
-### 9. 文件单个和批量分享
+
+
+### 7. 文件分享
+
+#### 7.1 单个或批量文件分享
1. 支持单个和批量分享文件给他人:
- 
+
2. 可以选择过期时间和是否需要提取码:
- 
+
3. 提供快捷复制链接及提取码给他人:
- 
+
粘贴分享链接及提取码效果:
```
- 分享链接:https://pan.qiwenshare.com/share/27d9b438019e4f68bcec02f579d163b7
- 提取码:356978
+ 分享链接:http://localhost:8080/share/363196ac9fd94371b9f47cb24f042d9f
+ 提取码:967617
复制链接到浏览器中并输入提取码即可查看文件
```
4. 他人查看分享内容,并支持保存到网盘功能:
- 
+
-### 10. 支持查看自己已分享过的文件列表
+#### 7.2 查看已分享过的文件列表
支持在列表中快捷复制当次的分享链接及提取码,并标注分享时间和过期状态:
-
+
-### 11. 视频在线预览
+### 8. 文件在线预览 & 编辑
+
+#### 8.1 office 在线预览 & 编辑
+
+本地启动时,office 文件在线预览需要在本地搭建 [only office](https://www.qiwenshare.com/essay/detail/1208) 服务;
+线上部署时,office 文件在线预览需要在服务器上搭建 [only office](https://www.qiwenshare.com/essay/detail/1208) 服务;
+
+例如:word 文件在线预览:
+
+
+例如:word 文件在线编辑:
+
+
+#### 8.2 视频在线预览
文件类型为视频时,点击即可打开预览窗口,展示播放列表,支持快进、后退、暂停、倍速播放、全屏播放、下载视频和折叠播放列表。
-
+视频播放器使用了 [vue-video-player](https://github.com/surmon-china/vue-video-player) ,具体配置项请查看该项目的官方文档,外层播放列表和操作栏为自行封装的。
-### 12. 音频在线播放
+
-
+#### 8.3 音频在线播放
+
+MP3 格式的文件支持在线播放。
+
+
## 联系我们
如您有问题,请加入 QQ 群咨询
-**QQ 交流群** 和 **微信公众号** 请扫描下面二维码
+**QQ 交流群**、**微信公众号 **或 **Gitee** 请扫描下面二维码
+
+
+
+项目的发展离不开你的支持,如果觉得这个项目帮助到了你,请点击评论区上方的捐赠,请作者喝杯咖啡吧!
+
+
-
## 鸣谢