mirror of
https://github.com/keven1024/015.git
synced 2026-05-26 07:08:02 +00:00
docs(README): update screenshots section for clarity, enhance quick start instructions, and refine project structure details
This commit is contained in:
keven1024
46
README-zh.md
46
README-zh.md
@@ -42,15 +42,15 @@
|
||||
## 📸 截图预览
|
||||
|
||||
| 选择文件上传页面 | 输入文本上传页面 |
|
||||
|---------------------------------------|-----------------------------------------------|
|
||||
| ------------------------- | ------------------------- |
|
||||
|  |  |
|
||||
|
||||
| 多选文件上传 | 文件上传进度热力图 |
|
||||
|------------------------------------------------|---------------------------------------------------|
|
||||
| ------------------------- | ------------------------- |
|
||||
|  |  |
|
||||
|
||||
| 文件上传进度条 | 文件上传成功页面 |
|
||||
|------------------------------------------------|-------------------------------------------------|
|
||||
| ------------------------- | ------------------------- |
|
||||
|  |  |
|
||||
|
||||
## 🚀 快速开始
|
||||
@@ -63,29 +63,13 @@
|
||||
|
||||
2. 把 config.example.yaml 配置完成后改为 config.yaml
|
||||
|
||||
|
||||
3. 启动
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
|
||||
## 🚀 快速开始
|
||||
|
||||
### Docker
|
||||
|
||||
1. 下载文件
|
||||
- config.example.yaml
|
||||
- docker-compose.yml
|
||||
|
||||
2. 把config.example.yaml配置完成后改为config.yaml
|
||||
|
||||
|
||||
3. 启动
|
||||
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
4. 访问 `http://localhost:8080`
|
||||
|
||||
## 🏗️ 技术架构
|
||||
|
||||
@@ -130,15 +114,15 @@ docker compose up -d
|
||||
015/
|
||||
├── front/ # 前端应用 (Vue 3 + Nuxt 3)
|
||||
│ ├── components/ # Vue 组件
|
||||
│ │ ├── pages/ # 页面路由
|
||||
│ │ ├── composables/ # 组合式函数
|
||||
│ │ ├── i18n/ # 国际化文件
|
||||
│ │ └── assets/ # 静态资源
|
||||
│ └── middleware/ # 中间件
|
||||
│ ├── pages/ # 页面路由
|
||||
│ ├── composables/ # 组合式函数
|
||||
│ ├── i18n/ # 国际化文件
|
||||
│ ├── assets/ # 静态资源
|
||||
│ ├── plugins/ # Nuxt 插件
|
||||
│ └── server/ # 服务端路由
|
||||
├── backend/ # 后端服务 (Go + Echo)
|
||||
│ ├── internal/ # 内部包
|
||||
│ │ ├── controllers/ # 控制器
|
||||
│ │ ├── models/ # 数据模型
|
||||
│ │ ├── services/ # 业务逻辑
|
||||
│ │ └── utils/ # 工具函数
|
||||
│ └── middleware/ # 中间件
|
||||
@@ -147,7 +131,7 @@ docker compose up -d
|
||||
│ │ ├── tasks/ # 任务处理器
|
||||
│ │ └── utils/ # 工具函数
|
||||
│ └── middleware/ # 中间件
|
||||
└── tmp/ # 临时文件
|
||||
└── pkg/ # 公共包
|
||||
```
|
||||
|
||||
## 🔧 开发指南
|
||||
@@ -186,19 +170,19 @@ cd worker && go build -o worker .
|
||||
- 前端计算哈希和秒传
|
||||
- 并发切片上传 (使用 Web Worker)
|
||||
- 文件上传/文本上传和分享
|
||||
- 支持多文件上传
|
||||
- 上传统计页面
|
||||
- 多语言支持
|
||||
- 最大上传限制
|
||||
- 后端队列系统和 Worker 处理文件
|
||||
- 断点续传 (后端计算已上传部分并返回)
|
||||
- 图片格式转换和压缩
|
||||
|
||||
### 计划功能 🚧
|
||||
|
||||
- 断点续传 (后端计算已上传部分并返回)
|
||||
- 图片格式转换和压缩
|
||||
- 图片 OCR 复制
|
||||
- 文档转 Markdown
|
||||
- 文本翻译/总结
|
||||
- 支持上传多文件
|
||||
|
||||
## 🤝 贡献指南
|
||||
|
||||
|
||||
58
README.md
58
README.md
@@ -42,17 +42,34 @@ English | [中文](README-zh.md)
|
||||
## 📸 Screenshots
|
||||
|
||||
| File Selection Upload Page | Text Input Upload Page |
|
||||
|---------------------------------------|-----------------------------------------------|
|
||||
| -------------------------- | ------------------------- |
|
||||
|  |  |
|
||||
|
||||
| Multiple File Upload | Upload Progress Heatmap |
|
||||
|------------------------------------------------|---------------------------------------------------|
|
||||
| -------------------------- | ------------------------- |
|
||||
|  |  |
|
||||
|
||||
| Upload Progress Bar | Upload Success Page |
|
||||
|------------------------------------------------|-------------------------------------------------|
|
||||
| -------------------------- | ------------------------- |
|
||||
|  |  |
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
### Docker
|
||||
|
||||
1. Download files
|
||||
- config.example.yaml
|
||||
- docker-compose.yml
|
||||
|
||||
2. Rename config.example.yaml to config.yaml after configuration
|
||||
|
||||
3. Start
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
4. Visit `http://localhost:8080`
|
||||
|
||||
## 🏗️ Technical Architecture
|
||||
|
||||
### Frontend Tech Stack
|
||||
@@ -90,36 +107,21 @@ English | [中文](README-zh.md)
|
||||
- **Redis Cache** - Share information and file metadata caching
|
||||
- **Queue System** - Asynchronous task processing queue
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
### Docker
|
||||
|
||||
1. Download files
|
||||
- config.example.yaml
|
||||
- docker-compose.yml
|
||||
|
||||
2. Rename config.example.yaml to config.yaml after configuration
|
||||
|
||||
3. Start
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
## 📁 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
|
||||
│ └── middleware/ # Middleware
|
||||
│ ├── pages/ # Page routes
|
||||
│ ├── composables/ # Composable functions
|
||||
│ ├── i18n/ # Internationalization files
|
||||
│ ├── assets/ # Static assets
|
||||
│ ├── plugins/ # Nuxt plugins
|
||||
│ └── server/ # Server-side routes
|
||||
├── backend/ # Backend service (Go + Echo)
|
||||
│ ├── internal/ # Internal packages
|
||||
│ │ ├── controllers/ # Controllers
|
||||
│ │ ├── models/ # Data models
|
||||
│ │ ├── services/ # Business logic
|
||||
│ │ └── utils/ # Utility functions
|
||||
│ └── middleware/ # Middleware
|
||||
@@ -128,7 +130,7 @@ docker compose up -d
|
||||
│ │ ├── tasks/ # Task processors
|
||||
│ │ └── utils/ # Utility functions
|
||||
│ └── middleware/ # Middleware
|
||||
└── tmp/ # Temporary files
|
||||
└── pkg/ # Shared packages
|
||||
```
|
||||
|
||||
## 🔧 Development Guide
|
||||
@@ -167,19 +169,19 @@ cd worker && go build -o worker .
|
||||
- Frontend hash calculation and instant transfer
|
||||
- Concurrent chunked upload (using Web Worker)
|
||||
- File upload/text upload and sharing
|
||||
- Multiple file upload support
|
||||
- Upload statistics page
|
||||
- Multi-language support
|
||||
- Maximum upload limits
|
||||
- Backend queue system and Worker file processing
|
||||
- Resume upload (backend calculates uploaded parts and returns)
|
||||
- Image format conversion and compression
|
||||
|
||||
### 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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user