feat(docs): 添加中文README文件,更新英文README中的图片路径,优化项目结构和环境配置说明

This commit is contained in:
keven
2025-09-23 00:28:54 +08:00
parent 8b0d90cdc3
commit 427d958a41
12 changed files with 152 additions and 119 deletions

BIN
.github/image/0.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 716 KiB

View File

Before

Width:  |  Height:  |  Size: 1.0 MiB

After

Width:  |  Height:  |  Size: 1.0 MiB

View File

Before

Width:  |  Height:  |  Size: 1.0 MiB

After

Width:  |  Height:  |  Size: 1.0 MiB

BIN
.github/image/3.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 MiB

BIN
.github/image/4.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 750 KiB

BIN
.github/image/5.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 807 KiB

BIN
.github/image/6.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

View File

@@ -1,10 +1,16 @@
<div align="center"><a name="readme-top"></a>
# 015
015 (/ˈzɪərəʊ wʌn faɪv/, "zero-one-five") 是一个支持selfhosted的临时文件分享平台。专注于提供一次性临时的文件和文本上传处理分享服务。项目名称来源于DARLING in the FRANXX的 [](https://darling-in-the-franxx.fandom.com/wiki/Ichigo)
一个基于 Vue 3 + Nuxt 3 + Go 构建的现代文件分享网站,支持文件上传、文本分享、图片压缩、并发处理、秒传功能等,具备完整的分享管理和访问控制体系。
![015 Platform Overview](./image/0.png)
![015 Platform Overview](/.github/image/0.png)
[English](README.md) | 中文
</div>
## 🌟 功能特性
@@ -35,13 +41,23 @@
## 截图
![](./image/1.webp)
选择文件上传页面
![](/.github/image/1.png)
![](./image/2.webp)
输入文本上传页面
![](/.github/image/2.png)
![](./image/3.png)
选择文件上传页面 - 支持多选文件上传
![](/.github/image/3.png)
![](./image/4.png)
文件正在上传页面 - 类似Github的展示上传进度的文件热力图
![](/.github/image/4.png)
文件正在上传页面 - 类似 QbitTorrent 的展示文件上传进度的进度条
![](/.github/image/5.png)
文件上传成功页面
![](/.github/image/6.png)
## 🏗️ 技术架构
@@ -113,7 +129,7 @@ cp .env.example .env
# 配置必要的环境变量
REDIS_URL=redis://localhost:6379
UPLOAD_PATH=./uploads
UPLOAD_PATH=/.github/uploads
download_secret=your_download_secret
```

View File

@@ -1,10 +1,16 @@
<div align="center"><a name="readme-top"></a>
# 015
015 (/ˈzɪərəʊ wʌn faɪv/, "zero-one-five") is a self-hosted temporary file sharing platform. Focused on providing one-time, temporary file and text upload, processing, and sharing services. The project name originates from [Ichigo](https://darling-in-the-franxx.fandom.com/wiki/Ichigo) from DARLING in the FRANXX.
A modern file sharing website built with Vue 3 + Nuxt 3 + Go, supporting file upload, text sharing, image compression, concurrent processing, instant transfer functionality, and more, featuring a complete sharing management and access control system.
![015 Platform Overview](/docs/image/0.png)
![015 Platform Overview](/.github/image/0.png)
English | [中文](README-zh.md)
</div>
## 🌟 Features
@@ -35,13 +41,23 @@ A modern file sharing website built with Vue 3 + Nuxt 3 + Go, supporting file up
## 📸 Screenshots
![](/docs/image/1.webp)
File selection upload page
![](/.github/image/1.png)
![](/docs/image/2.webp)
Text input upload page
![](/.github/image/2.png)
![](/docs/image/3.png)
File selection upload page - supports multiple file uploads
![](/.github/image/3.png)
![](/docs/image/4.png)
File uploading page - similar to GitHub's file heatmap showing upload progress
![](/.github/image/4.png)
File uploading page - similar to qBittorrent's progress bar showing file upload progress
![](/.github/image/5.png)
File upload success page
![](/.github/image/6.png)
## 🏗️ Technical Architecture
@@ -113,7 +129,7 @@ cp .env.example .env
# Configure necessary environment variables
REDIS_URL=redis://localhost:6379
UPLOAD_PATH=./uploads
UPLOAD_PATH=/.github/uploads
download_secret=your_download_secret
```
@@ -139,19 +155,20 @@ pnpm run dev:worker # Worker service
│ │ ├── composables/ # Composable functions
│ │ ├── i18n/ # Internationalization files
│ │ └── assets/ # Static assets
── backend/ # Backend service (Go + Echo)
│ │ ├── internal/ # Internal packages
│ │ ├── controllers/ # Controllers
│ │ │ ├── models/ # Data models
│ │ │ ├── services/ # Business logic
│ │ │ └── utils/ # Utility functions
│ │ └── middleware/ # Middleware
── worker/ # Asynchronous task processing (Go + Asynq)
│ │ ├── internal/ # Internal packages
│ │ ├── tasks/ # Task processors
│ │ │ └── utils/ # Utility functions
│ │ └── middleware/ # Middleware
│ └── tmp/ # Temporary files
── middleware/ # Middleware
├── backend/ # Backend service (Go + Echo)
├── internal/ # Internal packages
│ │ ├── controllers/ # Controllers
│ │ ├── models/ # Data models
│ │ ├── services/ # Business logic
│ │ └── utils/ # Utility functions
── middleware/ # Middleware
├── worker/ # Asynchronous task processing (Go + Asynq)
├── internal/ # Internal packages
│ │ ├── tasks/ # Task processors
│ │ └── utils/ # Utility functions
│ └── middleware/ # Middleware
└── tmp/ # Temporary files
```
## 🔧 Development Guide

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.8 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.0 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 654 KiB