feat(docs): 添加中文README文件,更新英文README中的图片路径,优化项目结构和环境配置说明
BIN
.github/image/0.png
vendored
Normal file
|
After Width: | Height: | Size: 716 KiB |
0
docs/image/3.png → .github/image/1.png
vendored
|
Before Width: | Height: | Size: 1.0 MiB After Width: | Height: | Size: 1.0 MiB |
0
docs/image/4.png → .github/image/2.png
vendored
|
Before Width: | Height: | Size: 1.0 MiB After Width: | Height: | Size: 1.0 MiB |
BIN
.github/image/3.png
vendored
Normal file
|
After Width: | Height: | Size: 1.4 MiB |
BIN
.github/image/4.png
vendored
Normal file
|
After Width: | Height: | Size: 750 KiB |
BIN
.github/image/5.png
vendored
Normal file
|
After Width: | Height: | Size: 807 KiB |
BIN
.github/image/6.png
vendored
Normal file
|
After Width: | Height: | Size: 1.1 MiB |
@@ -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 构建的现代文件分享网站,支持文件上传、文本分享、图片压缩、并发处理、秒传功能等,具备完整的分享管理和访问控制体系。
|
||||
|
||||

|
||||

|
||||
|
||||
[English](README.md) | 中文
|
||||
|
||||
</div>
|
||||
|
||||
## 🌟 功能特性
|
||||
|
||||
@@ -35,13 +41,23 @@
|
||||
|
||||
## 截图
|
||||
|
||||

|
||||
选择文件上传页面
|
||||

|
||||
|
||||

|
||||
输入文本上传页面
|
||||

|
||||
|
||||

|
||||
选择文件上传页面 - 支持多选文件上传
|
||||

|
||||
|
||||

|
||||
文件正在上传页面 - 类似Github的展示上传进度的文件热力图
|
||||

|
||||
|
||||
文件正在上传页面 - 类似 QbitTorrent 的展示文件上传进度的进度条
|
||||

|
||||
|
||||
文件上传成功页面
|
||||

|
||||
|
||||
## 🏗️ 技术架构
|
||||
|
||||
@@ -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
|
||||
```
|
||||
|
||||
55
README.md
@@ -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.
|
||||
|
||||

|
||||

|
||||
|
||||
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
|
||||
|
||||

|
||||
File selection upload page
|
||||

|
||||
|
||||

|
||||
Text input upload page
|
||||

|
||||
|
||||

|
||||
File selection upload page - supports multiple file uploads
|
||||

|
||||
|
||||

|
||||
File uploading page - similar to GitHub's file heatmap showing upload progress
|
||||

|
||||
|
||||
File uploading page - similar to qBittorrent's progress bar showing file upload progress
|
||||

|
||||
|
||||
File upload success page
|
||||

|
||||
|
||||
## 🏗️ 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
|
||||
|
||||
BIN
docs/image/0.png
|
Before Width: | Height: | Size: 1.8 MiB |
|
Before Width: | Height: | Size: 1.0 MiB |
|
Before Width: | Height: | Size: 654 KiB |