From 2a64313885db9abd355eb31ef6a1db993bc79ed8 Mon Sep 17 00:00:00 2001
From: liyating <2435065796@qq.com>
Date: Thu, 25 Mar 2021 13:15:19 +0800
Subject: [PATCH] =?UTF-8?q?README.md=20README.en.md=20=E6=9B=B4=E6=96=B0?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
README.en.md | 207 ++++++++++++++++++++++++++++++++++++++++++---------
README.md | 150 +++++++++++++++++++++----------------
2 files changed, 257 insertions(+), 100 deletions(-)
diff --git a/README.en.md b/README.en.md
index 9f13e99..ffb2d16 100644
--- a/README.en.md
+++ b/README.en.md
@@ -1,37 +1,170 @@
-# qiwen-file
-
-#### Description
-文件管理系统（仿百度网盘）
-基于springboot + vue 框架开发的Web文件系统，旨在为用户提供一个简单、方便的文件存储方案
-
-#### Software Architecture
-Software architecture description
-
-#### Installation
-
-1. xxxx
-2. xxxx
-3. xxxx
-
-#### Instructions
-
-1. xxxx
-2. xxxx
-3. xxxx
-
-#### Contribution
-
-1. Fork the repository
-2. Create Feat_xxx branch
-3. Commit your code
-4. Create Pull Request
-
-
-#### Gitee Feature
-
-1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md
-2. Gitee blog [blog.gitee.com](https://blog.gitee.com)
-3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore)
-4. The most valuable open source project [GVP](https://gitee.com/gvp)
-5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help)
-6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
+
+ 
+
+
+ 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 |
+ 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 uploading and downloading of files.
+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. ...
+
+## 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)
+
+## 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
+
+
+
+### 5. Move files
+
+
+
+### 6. Online file decompression
+
+
+
+### 7. File upload
+
+文件采用**分片上传**，集成了[simiple-uplader](https://github.com/simple-uploader/Uploader/blob/develop/README_zh-CN.md#uploader)的文件**秒传**、**断点续传**功能。
+
+
+### 8. Document Recycle Bin
+
+
+
+## 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
+
+
+
+
+
@@ -22,111 +21,137 @@
更新日志
--------------------------------------------------------------------------------
+---
## 开源说明
-系统100%开源
-本软件遵循MIT开源协议
- **您可以在其基础上继续进行开发来完善其功能，成为本项目的贡献者之一**
+系统 100%开源
+本软件遵循 MIT 开源协议
- **您也可以以该项目作为脚手架，进行其他项目的开发**
+**您可以在其基础上继续进行开发来完善其功能，成为本项目的贡献者之一**
+
+**您也可以以该项目作为脚手架，进行其他项目的开发**
+
+## 功能介绍
+
+### 用户操作
-## 功能
-#### 用户操作
1. 用户的登录和注册
-#### 文件操作
-1. 用户可对目录结构进行增加，删除，修改
-2. 提供文件的上传，下载，
-3. 支持对zip文件和rar文件的在线解压缩
-4. 支持文件和目录的移动和复制
+
+### 文件操作
+
+1. 用户可对目录结构进行增加，删除，修改
+2. 提供文件的上传，下载，
+3. 支持对 zip 文件和 rar 文件的在线解压缩
+4. 支持文件和目录的移动和复制
5. 多文件格式分类查看
-6. 支持阿里云OSS对象存储,FastDFS存储
-7. 增加分片上传，该功能同时支持本地存储和阿里云OSS,FastDFS
+6. 支持阿里云 OSS 对象存储,FastDFS 存储
+7. 增加分片上传，该功能同时支持本地存储和阿里云 OSS,FastDFS
8. 支持极速秒传功能，提高上传效率
9. 上传文件前台实时显示上传文件进度，上传速率，百分比等信息
10. 支持文件重命名
11. 可实时显示文件存储占用情况及总占用容量
-12. 支持ElasticSearch文件搜索
-13. ...
+12. 支持 ElasticSearch 文件搜索
+13. .……
-## 项目代码地址
-|系统|地址|
-|-|-|
-|奇文网盘前台|[https://gitee.com/qiwen-cloud/qiwen-file-web](https://gitee.com/qiwen-cloud/qiwen-file-web)|
-|奇文网盘后台|[https://gitee.com/qiwen-cloud/qiwen-file](https://gitee.com/qiwen-cloud/qiwen-file)|
+## 源码地址
+
+| 项目名称 | 源码地址 |
+| ------------ | -------------------------------------------------------------------------------------------- |
+| 奇文网盘前端 | [https://gitee.com/qiwen-cloud/qiwen-file-web](https://gitee.com/qiwen-cloud/qiwen-file-web) |
+| 奇文网盘后台 | [https://gitee.com/qiwen-cloud/qiwen-file](https://gitee.com/qiwen-cloud/qiwen-file) |
## 网络拓扑图
-
+
## 软件架构
+
该项目采用前后端分离的方式进行开发和部署,主要用到以下关键技术
-**前台**：elementui，vue-cli3, swipper， nodejs， webpack
+**前台**：Element UI、Vue CLI@3、Node.js、Webpack
-**后台**：springboot mybatis jpa jwt
+**后台**：Spring Boot、MyBatis、JPA、JWT
-**数据库** : mysql
+**数据库** : MySQL
**数据结构**：递归算法，树的遍历和插入...
-
## 使用说明
+
1、本项目为后端代码
-2、下载前台代码，可以访问该地址进行拉取
-前台代码源码：[源码](https://gitee.com/qiwen-cloud/qiwen-file-web)
+2、下载前端代码，可以访问该地址进行拉取：[qiwen-file-web](https://gitee.com/qiwen-cloud/qiwen-file-web)
+## 部分功能截图
+### 1. 网盘主页
-## 部分功能演示截图
- **主页** :yellow_heart:
-
+#### 1.1 页面布局
-
+- **左侧菜单栏区域：**展示文件类型，点击可以分类查看文件，底部显示已占用存储空间。
+- **顶部文件操作区域：**包括对文件的操作按钮组、文件查看模式切换按钮组、设置文件显示列按钮。
+- **右侧文件展示区域：**包括面包屑导航栏——标识当前位于的目录；文件展示区域——展示形式会随文件查看模式而改变；底部分页组件。
-
+
- **文件分类查看** :heart:
+#### 1.2 布局调整功能
-支持三种显示格式进行查看（列表，网格，时间线）
+左侧菜单栏可折叠，表格操作列可折叠，可控制当前表格中列的显示和隐藏
-列表
-
-网格
-
-时间线
-
+
- **创建文件夹** :blue_heart:
-
- **操作列展示** :purple_heart:
-
+#### 1.3 批量操作功能
-
- **文件的复制和移动** :heart:
-
- **文件在线解压缩** :green_heart:
-
- **上传进度显示**
-
- **上传进度框最小化**
-
+
+### 2. 三种查看模式
-## 联系我
-各种问题可扫描加入QQ群进行咨询
+文件查看支持三种展示模式（列表、网格和时间线模式）
-**QQ交流群**请扫描下面二维码
+#### 2.1 列表模式
-
+
-**微信公众号**请扫描下面二维码
+#### 2.2 网格模式
-
+
+#### 2.3 时间线模式
+
+
+### 3. 创建文件夹
+
+
+
+### 5. 文件移动
+
+
+
+### 6. 文件在线解压缩
+
+
+
+### 7. 文件上传
+
+文件采用**分片上传**，集成了[simiple-uplader](https://github.com/simple-uploader/Uploader/blob/develop/README_zh-CN.md#uploader)的文件**秒传**、**断点续传**功能。
+
+
+### 8. 文件回收站
+
+
+
+## 联系我们
+
+如您有问题，请加入 QQ 群咨询
+
+**QQ 交流群**和**微信公众号**请扫描下面二维码
+
+
+
+
+