README.md README.en.md 更新

This commit is contained in:
liyating 2021-03-25 13:15:19 +08:00
parent 693e63ca0a
commit 2a64313885
2 changed files with 257 additions and 100 deletions

View File

@ -1,37 +1,170 @@
# qiwen-file <p align="center">
<a href="http://fileos.qiwenshare.com/"><img width="30%" src="https://images.gitee.com/uploads/images/2020/0810/131432_e00bbf82_947714.png" ></a>
</p>
<p align="center">
<strong>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.</strong>
</p>
<p align="center">
<a target="_blank" href="https://baike.baidu.com/item/MIT%E8%AE%B8%E5%8F%AF%E8%AF%81/6671281?fr=aladdin">
<img src="https://img.shields.io/:license-MIT-blue.svg" />
</a>
<a target="_blank" href="https://www.oracle.com/technetwork/java/javase/downloads/index.html">
<img src="https://img.shields.io/badge/JDK-8+-green.svg" />
</a>
<a target="_blank" href="https://gitee.com/mingSoft/MCMS/stargazers">
<img src="https://gitee.com/qiwen-cloud/qiwen-file/badge/star.svg?theme=dark" alt='gitee star'/>
</a>
</p>
<p align="center">
<a href="http://pan.qiwenshare.com/" target="_blank">Online presentation environment</a> &nbsp;|
<a href="https://www.qiwenshare.com/essay/detail/169" target="_blank">Installation instructions</a>&nbsp;|
<a href="https://www.qiwenshare.com/essay/detail/324" target="_blank">Update log</a>
</p>
#### Description ---
文件管理系统(仿百度网盘)
基于springboot + vue 框架开发的Web文件系统旨在为用户提供一个简单、方便的文件存储方案
#### Software Architecture ## Open source that
Software architecture description
#### Installation System 100% open source
The software follows the MIT open source protocol
1. xxxx **You can build on it to improve its functionality and become a contributor to this project**
2. xxxx
3. xxxx
#### Instructions **You can also use this project as a scaffold for other projects**
1. xxxx ## Function is introduced
2. xxxx
3. xxxx
#### Contribution ### The user action
1. Fork the repository 1. User login and registration
2. Create Feat_xxx branch
3. Commit your code
4. Create Pull Request
### File operations
#### Gitee Feature 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. ...
1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md ## The source address
2. Gitee blog [blog.gitee.com](https://blog.gitee.com)
3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore) | The project name | The source address |
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) | The front project | [https://gitee.com/qiwen-cloud/qiwen-file-web](https://gitee.com/qiwen-cloud/qiwen-file-web) |
6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) | The background project | [https://gitee.com/qiwen-cloud/qiwen-file](https://gitee.com/qiwen-cloud/qiwen-file) |
## Network topology
![网络拓扑图](https://images.gitee.com/uploads/images/2021/0324/225520_d55b109e_947714.png '屏幕截图.png')
## 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.
![网盘主页](https://images.gitee.com/uploads/images/2021/0325/105935_225d3d46_1837873.png)
#### 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.
![折叠功能](https://images.gitee.com/uploads/images/2021/0325/113631_cf57fc44_1837873.gif)
#### 1.3 Batch operation function
![批量操作](https://images.gitee.com/uploads/images/2021/0325/115913_ad3bbe67_1837873.gif)
### 2. Three viewing modes
File viewing supports three presentation modes (list, grid, and timeline)
#### 2.1 List Mode
![列表模式](https://images.gitee.com/uploads/images/2021/0325/120007_1d046ef5_1837873.png)
#### 2.2 Grid Mode
![网格模式](https://images.gitee.com/uploads/images/2021/0325/123609_e4868707_1837873.png)
#### 2.3 Timeline Mode
![时间线模式](https://images.gitee.com/uploads/images/2021/0325/123638_3316ce8f_1837873.png)
### 3. Create a folder
![创建文件夹](https://images.gitee.com/uploads/images/2021/0325/123704_145604f0_1837873.png)
### 5. Move files
![文件移动](https://images.gitee.com/uploads/images/2021/0325/123752_14364633_1837873.png)
### 6. Online file decompression
![文件在线解压缩](https://images.gitee.com/uploads/images/2021/0325/123823_aba673e8_1837873.png)
### 7. File upload
文件采用**分片上传**,集成了[simiple-uplader](https://github.com/simple-uploader/Uploader/blob/develop/README_zh-CN.md#uploader)的文件**秒传**、**断点续传**功能。
![文件上传](https://images.gitee.com/uploads/images/2020/1127/211713_87fb01b2_947714.png '屏幕截图.png')
### 8. Document Recycle Bin
![文件回收站](https://images.gitee.com/uploads/images/2021/0325/123843_f8fa15bf_1837873.png)
## 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
<div style="dispaly: flex;">
<img src="https://images.gitee.com/uploads/images/2020/0406/164832_5121dc5e_947714.png" style="width: 200px;margin-right: 80px;"/>
<img src="https://images.gitee.com/uploads/images/2020/0406/164833_d99e92ee_947714.png" style="width: 200px;"/>
</div>
## 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/)

126
README.md
View File

@ -1,4 +1,3 @@
<p align="center"> <p align="center">
<a href="http://fileos.qiwenshare.com/"><img width="30%" src="https://images.gitee.com/uploads/images/2020/0810/131432_e00bbf82_947714.png" ></a> <a href="http://fileos.qiwenshare.com/"><img width="30%" src="https://images.gitee.com/uploads/images/2020/0810/131432_e00bbf82_947714.png" ></a>
</p> </p>
@ -22,9 +21,10 @@
<a href="https://www.qiwenshare.com/essay/detail/324" target="_blank">更新日志</a> <a href="https://www.qiwenshare.com/essay/detail/324" target="_blank">更新日志</a>
</p> </p>
------------------------------------------------------------------------------- ---
## 开源说明 ## 开源说明
系统 100%开源 系统 100%开源
本软件遵循 MIT 开源协议 本软件遵循 MIT 开源协议
@ -32,10 +32,14 @@
**您也可以以该项目作为脚手架,进行其他项目的开发** **您也可以以该项目作为脚手架,进行其他项目的开发**
## 功能 ## 功能介绍
#### 用户操作
### 用户操作
1. 用户的登录和注册 1. 用户的登录和注册
#### 文件操作
### 文件操作
1. 用户可对目录结构进行增加,删除,修改 1. 用户可对目录结构进行增加,删除,修改
2. 提供文件的上传,下载, 2. 提供文件的上传,下载,
3. 支持对 zip 文件和 rar 文件的在线解压缩 3. 支持对 zip 文件和 rar 文件的在线解压缩
@ -48,85 +52,106 @@
10. 支持文件重命名 10. 支持文件重命名
11. 可实时显示文件存储占用情况及总占用容量 11. 可实时显示文件存储占用情况及总占用容量
12. 支持 ElasticSearch 文件搜索 12. 支持 ElasticSearch 文件搜索
13. ... 13. .……
## 项目代码地址 ## 源码地址
|系统|地址|
|-|-| | 项目名称 | 源码地址 |
|奇文网盘前台|[https://gitee.com/qiwen-cloud/qiwen-file-web](https://gitee.com/qiwen-cloud/qiwen-file-web)| | ------------ | -------------------------------------------------------------------------------------------- |
| 奇文网盘前端 | [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](https://gitee.com/qiwen-cloud/qiwen-file) |
## 网络拓扑图 ## 网络拓扑图
![输入图片说明](https://images.gitee.com/uploads/images/2021/0324/225520_d55b109e_947714.png "屏幕截图.png") ![输入图片说明](https://images.gitee.com/uploads/images/2021/0324/225520_d55b109e_947714.png '屏幕截图.png')
## 软件架构 ## 软件架构
该项目采用前后端分离的方式进行开发和部署,主要用到以下关键技术 该项目采用前后端分离的方式进行开发和部署,主要用到以下关键技术
**前台**elementuivue-cli3, swipper nodejs webpack **前台**Element UI、Vue CLI@3、Node.js、Webpack
**后台**springboot mybatis jpa jwt **后台**Spring Boot、MyBatis、JPA、JWT
**数据库** : mysql **数据库** : MySQL
**数据结构**:递归算法,树的遍历和插入... **数据结构**:递归算法,树的遍历和插入...
## 使用说明 ## 使用说明
1、本项目为后端代码 1、本项目为后端代码
2、下载前台代码可以访问该地址进行拉取 2、下载前端代码可以访问该地址进行拉取[qiwen-file-web](https://gitee.com/qiwen-cloud/qiwen-file-web)
前台代码源码:[源码](https://gitee.com/qiwen-cloud/qiwen-file-web)
## 部分功能截图
### 1. 网盘主页
## 部分功能演示截图 #### 1.1 页面布局
**主页** :yellow_heart:
![新版主页](https://images.gitee.com/uploads/images/2020/0409/182847_8f60ac83_1837873.png "屏幕截图.png")
![新功能](https://images.gitee.com/uploads/images/2020/0409/183222_fa2282c6_1837873.png "屏幕截图.png") - **左侧菜单栏区域:**展示文件类型,点击可以分类查看文件,底部显示已占用存储空间。
- **顶部文件操作区域:**包括对文件的操作按钮组、文件查看模式切换按钮组、设置文件显示列按钮。
- **右侧文件展示区域:**包括面包屑导航栏——标识当前位于的目录;文件展示区域——展示形式会随文件查看模式而改变;底部分页组件。
![左侧菜单栏收缩](https://images.gitee.com/uploads/images/2020/0409/183644_a6902a69_1837873.png "屏幕截图.png") ![网盘主页](https://images.gitee.com/uploads/images/2021/0325/105935_225d3d46_1837873.png)
**文件分类查看** :heart: #### 1.2 布局调整功能
支持三种显示格式进行查看(列表,网格,时间线) 左侧菜单栏可折叠,表格操作列可折叠,可控制当前表格中列的显示和隐藏
列表 ![折叠功能](https://images.gitee.com/uploads/images/2021/0325/113631_cf57fc44_1837873.gif)
![输入图片说明](https://images.gitee.com/uploads/images/2020/0415/001030_f8caf4fb_947714.png "屏幕截图.png")
网格
![输入图片说明](https://images.gitee.com/uploads/images/2020/0415/001114_fc708749_947714.png "屏幕截图.png")
时间线
![输入图片说明](https://images.gitee.com/uploads/images/2020/0415/000833_ee93793e_947714.png "屏幕截图.png")
**创建文件夹** :blue_heart: #### 1.3 批量操作功能
![输入图片说明](https://images.gitee.com/uploads/images/2019/1022/205531_b3bf3380_947714.png "屏幕截图.png")
**操作列展示** :purple_heart:
![操作列扩展](https://images.gitee.com/uploads/images/2020/0409/183336_ab936775_1837873.png "屏幕截图.png")
![操作列合并](https://images.gitee.com/uploads/images/2020/0409/183412_6a3ed5e0_1837873.png "屏幕截图.png") ![批量操作](https://images.gitee.com/uploads/images/2021/0325/115913_ad3bbe67_1837873.gif)
**文件的复制和移动** :heart:
![输入图片说明](https://images.gitee.com/uploads/images/2019/1022/210106_d4b619f3_947714.png "屏幕截图.png")
**文件在线解压缩** :green_heart:
![输入图片说明](https://images.gitee.com/uploads/images/2019/1022/210214_c00f5600_947714.png "屏幕截图.png")
**上传进度显示**
![输入图片说明](https://images.gitee.com/uploads/images/2020/1127/211713_87fb01b2_947714.png "屏幕截图.png")
**上传进度框最小化**
![输入图片说明](https://images.gitee.com/uploads/images/2020/1127/211845_e88c61b1_947714.png "屏幕截图.png")
### 2. 三种查看模式
## 联系我 文件查看支持三种展示模式(列表、网格和时间线模式)
各种问题可扫描加入QQ群进行咨询
**QQ交流群**请扫描下面二维码 #### 2.1 列表模式
<img width="30%" src="https://images.gitee.com/uploads/images/2020/0406/164832_5121dc5e_947714.png"/> ![列表模式](https://images.gitee.com/uploads/images/2021/0325/120007_1d046ef5_1837873.png)
**微信公众号**请扫描下面二维码 #### 2.2 网格模式
<img width="30%" src="https://images.gitee.com/uploads/images/2020/0406/164833_d99e92ee_947714.png"/> ![网格模式](https://images.gitee.com/uploads/images/2021/0325/123609_e4868707_1837873.png)
#### 2.3 时间线模式
![时间线模式](https://images.gitee.com/uploads/images/2021/0325/123638_3316ce8f_1837873.png)
### 3. 创建文件夹
![创建文件夹](https://images.gitee.com/uploads/images/2021/0325/123704_145604f0_1837873.png)
### 5. 文件移动
![文件移动](https://images.gitee.com/uploads/images/2021/0325/123752_14364633_1837873.png)
### 6. 文件在线解压缩
![文件在线解压缩](https://images.gitee.com/uploads/images/2021/0325/123823_aba673e8_1837873.png)
### 7. 文件上传
文件采用**分片上传**,集成了[simiple-uplader](https://github.com/simple-uploader/Uploader/blob/develop/README_zh-CN.md#uploader)的文件**秒传**、**断点续传**功能。
![文件上传](https://images.gitee.com/uploads/images/2020/1127/211713_87fb01b2_947714.png '屏幕截图.png')
### 8. 文件回收站
![文件回收站](https://images.gitee.com/uploads/images/2021/0325/123843_f8fa15bf_1837873.png)
## 联系我们
如您有问题,请加入 QQ 群咨询
**QQ 交流群**和**微信公众号**请扫描下面二维码
<div style="dispaly: flex;">
<img src="https://images.gitee.com/uploads/images/2020/0406/164832_5121dc5e_947714.png" style="width: 200px;margin-right: 80px;"/>
<img src="https://images.gitee.com/uploads/images/2020/0406/164833_d99e92ee_947714.png" style="width: 200px;"/>
</div>
## 参与贡献 ## 参与贡献
@ -135,10 +160,9 @@
3. 提交代码 3. 提交代码
4. 新建 Pull Request 4. 新建 Pull Request
## 码云特技 ## 码云特技
1. 使用 Readme\_XXX.md 来支持不同的语言,例如 Readme\_en.md, Readme\_zh.md 1. 使用 Readme_XXX.md 来支持不同的语言,例如 Readme_en.md, Readme_zh.md
2. 码云官方博客 [blog.gitee.com](https://blog.gitee.com) 2. 码云官方博客 [blog.gitee.com](https://blog.gitee.com)
3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解码云上的优秀开源项目 3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解码云上的优秀开源项目
4. [GVP](https://gitee.com/gvp) 全称是码云最有价值开源项目,是码云综合评定出的优秀开源项目 4. [GVP](https://gitee.com/gvp) 全称是码云最有价值开源项目,是码云综合评定出的优秀开源项目