mirror of
https://github.com/keven1024/015.git
synced 2026-05-26 15:13:30 +00:00
feat: 更新 README 和新增中文文档,详细介绍 015 文件分享平台的功能、技术架构及快速开始指南
This commit is contained in:
232
README.md
232
README.md
@@ -1,20 +1,220 @@
|
||||
# 015
|
||||
|
||||
这里是send企划
|
||||
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.
|
||||
|
||||
功能:
|
||||
- ✅ 前端计算hash和秒传
|
||||
- ✅ 并发切片上传 (使用webWorker计算)
|
||||
- ✅ 文件上传/文本上传和分享
|
||||
- ✅ 上传统计页面
|
||||
- ✅ 多语言支持
|
||||
- ✅ 最大上传限制
|
||||
- ✅ 后端有队列系统和worker处理文件
|
||||
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.
|
||||
|
||||
todo:
|
||||
- 断点续传(后端计算已上传部分并返回)
|
||||
- 图片格式转换 压缩
|
||||
- 图片ocr 复制
|
||||
- xx转markdown
|
||||
- 文本翻译/总结
|
||||
- 支持上传多文件
|
||||

|
||||
|
||||
## 🌟 Features
|
||||
|
||||
### Core Functionality
|
||||
|
||||
🖼️ **High-Performance File Upload** - Supports large file chunked uploads with frontend file hash calculation for instant transfer
|
||||
📱 **Responsive Design** - Modern UI based on Tailwind V4 + Reka UI, adapts to various devices
|
||||
⚡ **Concurrent Processing** - Uses Web Worker for frontend hash calculation, backend queue system for task processing
|
||||
🌐 **Multi-language Support** - Complete Chinese and English internationalization support
|
||||
🔗 **Share Management** - Flexible sharing link generation and management system
|
||||
|
||||
### File Processing
|
||||
|
||||
🔄 **Smart Instant Transfer** - Frontend instant transfer detection based on file hash + file size, avoiding duplicate uploads
|
||||
📷 **Image Compression** - Automatic image compression functionality supporting multiple formats
|
||||
🖼️ **File Preview** - Supports preview of images, videos, audio, documents, and various file types
|
||||
📊 **Upload Statistics** - Real-time display of upload progress and file information
|
||||
🌈 **Resume Upload** - Supports resuming uploads after interruption
|
||||
|
||||
### Advanced Features
|
||||
|
||||
🎛️ **Share Control** - Supports password protection, download count limits, and expiration time settings
|
||||
🔍 **Pickup Code System** - Supports pickup code sharing, simplifying sharing difficulty
|
||||
⚡ **Queue Processing** - Asynchronous task processing system based on Redis + Asynq
|
||||
🗂️ **File Management** - Complete file lifecycle management
|
||||
📷 **Image Processing** - Image compression, format conversion, and other processing features
|
||||
🏷️ **Download Control** - Download token management system based on JWT
|
||||
|
||||
## 📸 Screenshots
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
## 🏗️ Technical Architecture
|
||||
|
||||
### Frontend Tech Stack
|
||||
|
||||
- **Vue 3** - Progressive JavaScript framework
|
||||
- **Nuxt 3** - Vue.js full-stack framework
|
||||
- **TypeScript** - Complete type safety
|
||||
- **Tailwind CSS** - Atomic CSS framework
|
||||
- **Reka UI** - Modern component library
|
||||
- **Pinia** - State management
|
||||
- **TanStack Query** - Data fetching and caching
|
||||
- **Vue Router** - Routing management
|
||||
- **i18next** - Internationalization support
|
||||
|
||||
### Backend Tech Stack
|
||||
|
||||
- **Go 1.23** - High-performance server-side language
|
||||
- **Echo** - High-performance HTTP framework
|
||||
- **Redis** - Caching and session storage
|
||||
- **Asynq** - Asynchronous task queue
|
||||
- **JWT** - Authentication
|
||||
- **Zap** - Structured logging
|
||||
|
||||
### Build System
|
||||
|
||||
- **Node.js** - Server-side runtime
|
||||
- **pnpm** - Fast package manager
|
||||
- **Husky** - Git hooks management
|
||||
- **Prettier** - Code formatting
|
||||
- **Lint-staged** - Staged file checking
|
||||
|
||||
### Storage Architecture
|
||||
|
||||
- **File Storage** - Local file system storage
|
||||
- **Redis Cache** - Share information and file metadata caching
|
||||
- **Queue System** - Asynchronous task processing queue
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
### Requirements
|
||||
|
||||
- Node.js 18+
|
||||
- Go 1.23+
|
||||
- Redis 6+
|
||||
- pnpm 9+
|
||||
|
||||
### Install Dependencies
|
||||
|
||||
```bash
|
||||
# Install root dependencies
|
||||
pnpm install
|
||||
|
||||
# Install frontend dependencies
|
||||
cd front && pnpm install
|
||||
|
||||
# Install backend dependencies
|
||||
cd backend && go mod download
|
||||
|
||||
# Install Worker dependencies
|
||||
cd worker && go mod download
|
||||
```
|
||||
|
||||
### Environment Configuration
|
||||
|
||||
```bash
|
||||
# Copy environment variables file
|
||||
cp .env.example .env
|
||||
|
||||
# Configure necessary environment variables
|
||||
REDIS_URL=redis://localhost:6379
|
||||
UPLOAD_PATH=./uploads
|
||||
download_secret=your_download_secret
|
||||
```
|
||||
|
||||
### Start Services
|
||||
|
||||
```bash
|
||||
# Start all services in development mode
|
||||
pnpm run dev
|
||||
|
||||
# Or start separately
|
||||
pnpm run dev:front # Frontend service (port 5000)
|
||||
pnpm run dev:backend # Backend service (port 1323)
|
||||
pnpm run dev:worker # Worker service
|
||||
```
|
||||
|
||||
## 📁 Project Structure
|
||||
|
||||
```
|
||||
015/
|
||||
├── front/ # Frontend application (Vue 3 + Nuxt 3)
|
||||
│ ├── components/ # Vue components
|
||||
│ │ ├── pages/ # Page routes
|
||||
│ │ ├── 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
|
||||
```
|
||||
|
||||
## 🔧 Development Guide
|
||||
|
||||
### Code Standards
|
||||
|
||||
- Use Prettier for code formatting
|
||||
- Use Husky + lint-staged for pre-commit checking
|
||||
- Follow TypeScript type safety standards
|
||||
|
||||
### Commit Standards
|
||||
|
||||
```bash
|
||||
# Code formatting will run automatically before commit
|
||||
git add .
|
||||
git commit -m "feat: add new feature"
|
||||
```
|
||||
|
||||
### Build and Deploy
|
||||
|
||||
```bash
|
||||
# Build frontend
|
||||
cd front && pnpm run build
|
||||
|
||||
# Build backend (requires Go environment)
|
||||
cd backend && go build -o main .
|
||||
|
||||
# Build Worker
|
||||
cd worker && go build -o worker .
|
||||
```
|
||||
|
||||
## 📝 Development Roadmap
|
||||
|
||||
### Completed Features ✅
|
||||
|
||||
- Frontend hash calculation and instant transfer
|
||||
- Concurrent chunked upload (using Web Worker)
|
||||
- File upload/text upload and sharing
|
||||
- Upload statistics page
|
||||
- Multi-language support
|
||||
- Maximum upload limits
|
||||
- Backend queue system and Worker file processing
|
||||
|
||||
### Planned Features 🚧
|
||||
|
||||
- Resume upload (backend calculates uploaded parts and returns)
|
||||
- Image format conversion and compression
|
||||
- Image OCR copy
|
||||
- Document to Markdown conversion
|
||||
- Text translation/summarization
|
||||
- Support for multiple file uploads
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
Welcome to submit Issues and Pull Requests to improve this project.
|
||||
|
||||
## 📄 License
|
||||
|
||||
This project is licensed under AGPLV3.
|
||||
|
||||
## 🔗 Related Links
|
||||
|
||||
- [Vue 3 Documentation](https://vuejs.org/)
|
||||
- [Nuxt 3 Documentation](https://nuxt.com/)
|
||||
- [Echo Framework Documentation](https://echo.labstack.com/)
|
||||
- [Asynq Documentation](https://github.com/hibiken/asynq)
|
||||
|
||||
221
docs/README-zh.md
Normal file
221
docs/README-zh.md
Normal file
@@ -0,0 +1,221 @@
|
||||
# 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 构建的现代文件分享网站,支持文件上传、文本分享、图片压缩、并发处理、秒传功能等,具备完整的分享管理和访问控制体系。
|
||||
|
||||

|
||||
|
||||
## 🌟 功能特性
|
||||
|
||||
### 核心功能
|
||||
|
||||
🖼️ **高性能文件上传** - 支持大文件切片上传,前端计算文件哈希实现秒传
|
||||
📱 **响应式设计** - 基于 Tailwind V4 + Reka UI 的现代化 UI,适配各种设备
|
||||
⚡ **并发处理** - 使用 Web Worker 进行前端Hash计算,后端队列系统处理任务
|
||||
🌐 **多语言支持** - 完整的中英文国际化支持
|
||||
🔗 **分享管理** - 灵活的分享链接生成和管理系统
|
||||
|
||||
### 文件处理
|
||||
|
||||
🔄 **智能秒传** - 基于文件哈希+文件大小的前端秒传检测,避免重复上传
|
||||
📷 **图片压缩** - 自动图片压缩功能,支持多种格式
|
||||
🖼️ **文件预览** - 支持图片、视频、音频、文档等多种文件类型预览
|
||||
📊 **上传统计** - 实时显示上传进度和文件信息
|
||||
🌈 **断点续传** - 支持上传中断后的续传功能
|
||||
|
||||
### 高级功能
|
||||
|
||||
🎛️ **分享控制** - 支持密码保护、下载次数限制、过期时间设置
|
||||
🔍 **取件码系统** - 支持取件码分享,简化分享难度
|
||||
⚡ **队列处理** - 基于 Redis + Asynq 的异步任务处理系统
|
||||
🗂️ **文件管理** - 完整的文件生命周期管理
|
||||
📷 **图片处理** - 图片压缩、格式转换等处理功能
|
||||
🏷️ **下载控制** - 基于 JWT 的下载令牌管理系统
|
||||
|
||||
## 截图
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
## 🏗️ 技术架构
|
||||
|
||||
### 前端技术栈
|
||||
|
||||
- **Vue 3** - 渐进式 JavaScript 框架
|
||||
- **Nuxt 3** - Vue.js 全栈框架
|
||||
- **TypeScript** - 完整的类型安全
|
||||
- **Tailwind CSS** - 原子化 CSS 框架
|
||||
- **Reka UI** - 现代化组件库
|
||||
- **Pinia** - 状态管理
|
||||
- **TanStack Query** - 数据获取和缓存
|
||||
- **Vue Router** - 路由管理
|
||||
- **i18next** - 国际化支持
|
||||
|
||||
### 后端技术栈
|
||||
|
||||
- **Go 1.23** - 高性能服务器端语言
|
||||
- **Echo** - 高性能 HTTP 框架
|
||||
- **Redis** - 缓存和会话存储
|
||||
- **Asynq** - 异步任务队列
|
||||
- **JWT** - 身份验证
|
||||
- **Zap** - 结构化日志
|
||||
|
||||
### 构建系统
|
||||
|
||||
- **Node.js** - 服务器端运行时
|
||||
- **pnpm** - 快速包管理器
|
||||
- **Husky** - Git hooks 管理
|
||||
- **Prettier** - 代码格式化
|
||||
- **Lint-staged** - 暂存文件检查
|
||||
|
||||
### 存储架构
|
||||
|
||||
- **文件存储** - 本地文件系统存储
|
||||
- **Redis 缓存** - 分享信息、文件元数据缓存
|
||||
- **队列系统** - 异步任务处理队列
|
||||
|
||||
## 🚀 快速开始
|
||||
|
||||
### 环境要求
|
||||
|
||||
- Node.js 18+
|
||||
- Go 1.23+
|
||||
- Redis 6+
|
||||
- pnpm 9+
|
||||
|
||||
### 安装依赖
|
||||
|
||||
```bash
|
||||
# 安装根目录依赖
|
||||
pnpm install
|
||||
|
||||
# 安装前端依赖
|
||||
cd front && pnpm install
|
||||
|
||||
# 安装后端依赖
|
||||
cd backend && go mod download
|
||||
|
||||
# 安装 Worker 依赖
|
||||
cd worker && go mod download
|
||||
```
|
||||
|
||||
### 环境配置
|
||||
|
||||
```bash
|
||||
# 复制环境变量文件
|
||||
cp .env.example .env
|
||||
|
||||
# 配置必要的环境变量
|
||||
REDIS_URL=redis://localhost:6379
|
||||
UPLOAD_PATH=./uploads
|
||||
download_secret=your_download_secret
|
||||
```
|
||||
|
||||
### 启动服务
|
||||
|
||||
```bash
|
||||
# 开发模式启动所有服务
|
||||
pnpm run dev
|
||||
|
||||
# 或分别启动
|
||||
pnpm run dev:front # 前端服务 (端口 5000)
|
||||
pnpm run dev:backend # 后端服务 (端口 1323)
|
||||
pnpm run dev:worker # Worker 服务
|
||||
```
|
||||
|
||||
## 📁 项目结构
|
||||
|
||||
```
|
||||
015/
|
||||
├── front/ # 前端应用 (Vue 3 + Nuxt 3)
|
||||
│ ├── components/ # Vue 组件
|
||||
│ │ ├── pages/ # 页面路由
|
||||
│ │ ├── composables/ # 组合式函数
|
||||
│ │ ├── i18n/ # 国际化文件
|
||||
│ │ └── assets/ # 静态资源
|
||||
│ └── middleware/ # 中间件
|
||||
├── backend/ # 后端服务 (Go + Echo)
|
||||
│ ├── internal/ # 内部包
|
||||
│ │ ├── controllers/ # 控制器
|
||||
│ │ ├── models/ # 数据模型
|
||||
│ │ ├── services/ # 业务逻辑
|
||||
│ │ └── utils/ # 工具函数
|
||||
│ └── middleware/ # 中间件
|
||||
├── worker/ # 异步任务处理 (Go + Asynq)
|
||||
│ ├── internal/ # 内部包
|
||||
│ │ ├── tasks/ # 任务处理器
|
||||
│ │ └── utils/ # 工具函数
|
||||
│ └── middleware/ # 中间件
|
||||
└── tmp/ # 临时文件
|
||||
```
|
||||
|
||||
## 🔧 开发指南
|
||||
|
||||
### 代码规范
|
||||
|
||||
- 使用 Prettier 进行代码格式化
|
||||
- 使用 Husky + lint-staged 进行提交前检查
|
||||
- 遵循 TypeScript 类型安全规范
|
||||
|
||||
### 提交规范
|
||||
|
||||
```bash
|
||||
# 提交前会自动运行代码格式化
|
||||
git add .
|
||||
git commit -m "feat: add new feature"
|
||||
```
|
||||
|
||||
### 构建部署
|
||||
|
||||
```bash
|
||||
# 构建前端
|
||||
cd front && pnpm run build
|
||||
|
||||
# 构建后端 (需要 Go 环境)
|
||||
cd backend && go build -o main .
|
||||
|
||||
# 构建 Worker
|
||||
cd worker && go build -o worker .
|
||||
```
|
||||
|
||||
## 📝 开发计划
|
||||
|
||||
### 已完成功能 ✅
|
||||
|
||||
- 前端计算哈希和秒传
|
||||
- 并发切片上传 (使用 Web Worker)
|
||||
- 文件上传/文本上传和分享
|
||||
- 上传统计页面
|
||||
- 多语言支持
|
||||
- 最大上传限制
|
||||
- 后端队列系统和 Worker 处理文件
|
||||
|
||||
### 计划功能 🚧
|
||||
|
||||
- 断点续传 (后端计算已上传部分并返回)
|
||||
- 图片格式转换和压缩
|
||||
- 图片 OCR 复制
|
||||
- 文档转 Markdown
|
||||
- 文本翻译/总结
|
||||
- 支持上传多文件
|
||||
|
||||
## 🤝 贡献指南
|
||||
|
||||
欢迎提交 Issue 和 Pull Request 来改进这个项目。
|
||||
|
||||
## 📄 许可证
|
||||
|
||||
本项目采用 AGPLV3 许可证。
|
||||
|
||||
## 🔗 相关链接
|
||||
|
||||
- [Vue 3 文档](https://vuejs.org/)
|
||||
- [Nuxt 3 文档](https://nuxt.com/)
|
||||
- [Echo 框架文档](https://echo.labstack.com/)
|
||||
- [Asynq 文档](https://github.com/hibiken/asynq)
|
||||
BIN
docs/image/0.png
Normal file
BIN
docs/image/0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.8 MiB |
BIN
docs/image/1.webp
Normal file
BIN
docs/image/1.webp
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.0 MiB |
BIN
docs/image/2.webp
Normal file
BIN
docs/image/2.webp
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 654 KiB |
BIN
docs/image/3.png
Normal file
BIN
docs/image/3.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.0 MiB |
BIN
docs/image/4.png
Normal file
BIN
docs/image/4.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.0 MiB |
Reference in New Issue
Block a user