mirror of
https://github.com/keven1024/015.git
synced 2026-05-26 07:08:02 +00:00
docs: update README files to streamline Docker setup instructions and remove outdated environment configuration details
(cherry picked from commit 4355a29a52)
This commit is contained in:
66
README-zh.md
66
README-zh.md
@@ -59,6 +59,23 @@
|
||||
文件上传成功页面
|
||||

|
||||
|
||||
## 🚀 快速开始
|
||||
|
||||
### Docker
|
||||
|
||||
1. 下载文件
|
||||
- config.example.yaml
|
||||
- docker-compose.yml
|
||||
|
||||
2. 把config.example.yaml配置完成后改为config.yaml
|
||||
|
||||
|
||||
3. 启动
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
|
||||
## 🏗️ 技术架构
|
||||
|
||||
### 前端技术栈
|
||||
@@ -96,55 +113,6 @@
|
||||
- **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=/.github/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 服务
|
||||
```
|
||||
|
||||
## 📁 项目结构
|
||||
|
||||
```
|
||||
|
||||
48
README.md
48
README.md
@@ -98,51 +98,17 @@ File upload success page
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
### Requirements
|
||||
### Docker
|
||||
|
||||
- Node.js 18+
|
||||
- Go 1.23+
|
||||
- Redis 6+
|
||||
- pnpm 9+
|
||||
1. Download files
|
||||
- config.example.yaml
|
||||
- docker-compose.yml
|
||||
|
||||
### Install Dependencies
|
||||
2. Rename config.example.yaml to config.yaml after configuration
|
||||
|
||||
3. Start
|
||||
```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=/.github/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
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
## 📁 Project Structure
|
||||
|
||||
Reference in New Issue
Block a user