# OpenDrive

**Repository Path**: chengzi404-byte/open-drive

## Basic Information

- **Project Name**: OpenDrive
- **Description**: OpenDrive - 让存储数据更加简单安全
- **Primary Language**: TypeScript
- **License**: LGPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-18
- **Last Updated**: 2026-02-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Flask, Python, Web

## README

# Open Drive - 开源网盘项目

Open Drive 是一个基于现代技术栈开发的开源网盘系统，提供文件存储、管理、分享等功能。

## 技术栈

### 客户端
- React 19
- TypeScript
- Vite
- Tailwind CSS
- ESLint

### 服务器端
- Node.js
- Express 5
- TypeScript
- MongoDB (Mongoose)
- Redis
- BullMQ (任务队列)
- JWT (认证)
- BCrypt (密码加密)

## 项目结构

```
open-drive/
├── client/              # 前端代码
│   ├── public/          # 静态资源
│   ├── src/             # 源代码
│   ├── package.json     # 前端依赖
│   └── vite.config.ts   # Vite 配置
├── server/              # 后端代码
│   ├── dist/            # 编译输出
│   ├── src/             # 源代码
│   ├── package.json     # 后端依赖
│   └── tsconfig.json    # TypeScript 配置
├── .gitignore           # Git 忽略规则
├── .gitattributes       # Git 属性配置
└── README.md           # 项目说明
```

## 功能特性

### 核心功能
- 用户注册和登录
- 文件上传和下载
- 文件管理（创建、删除、重命名、移动）
- 文件分享
- 文件夹支持

### 技术特性
- 前后端分离架构
- 异步任务处理（BullMQ）
- 缓存机制（Redis）
- 安全认证（JWT + BCrypt）
- 类型安全（TypeScript）
- 现代化开发工具链

## 安装和运行

### 前置要求
- Node.js 18+ 
- MongoDB 6+ 
- Redis 7+ 

### 安装步骤

1. **克隆项目**
   ```bash
   git clone <repository-url>
   cd open-drive
   ```

2. **安装依赖**
   
   - 安装前端依赖
   ```bash
   cd client
   npm install
   cd ..
   ```
   
   - 安装后端依赖
   ```bash
   cd server
   npm install
   cd ..
   ```

3. **配置环境变量**
   
   在 `server` 目录下创建 `.env` 文件，添加以下配置：
   ```
   PORT=3001
   MONGODB_URI=mongodb://localhost:27017/open-drive
   REDIS_URL=redis://localhost:6379
   JWT_SECRET=your-jwt-secret-key
   ```

4. **启动服务**
   
   - 启动后端服务（开发模式）
   ```bash
   cd server
   npm run dev
   ```
   
   - 启动前端服务（开发模式）
   ```bash
   cd client
   npm run dev
   ```

5. **访问应用**
   
   前端：http://localhost:5173
   后端 API：http://localhost:3001

## 开发指南

### 代码规范
- 前端：ESLint + TypeScript
- 后端：TypeScript

### 构建生产版本

- 构建前端
```bash
cd client
npm run build
```

- 构建后端
```bash
cd server
npm run build
```

- 启动生产服务器
```bash
cd server
npm start
```

## 项目进度

根据项目实现计划，我们将按照以下阶段开发：

1. **基础架构搭建** - ✅ 完成
   - 前后端项目初始化
   - 数据库连接配置
   - 认证系统实现

2. **核心功能开发** - 进行中
   - 文件上传下载功能
   - 文件管理功能
   - 文件夹支持

3. **高级功能开发** - 计划中
   - 文件分享功能
   - 权限管理
   - 搜索功能
   - 断点续传

4. **优化和部署** - 计划中
   - 性能优化
   - 安全性增强
   - 部署指南

## 贡献指南

欢迎贡献代码！请遵循以下步骤：

1. Fork 项目
2. 创建功能分支 (`git checkout -b feature/AmazingFeature`)
3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 打开 Pull Request

## 许可证

本项目采用 MIT 许可证。详情请查看 [LICENSE](LICENSE) 文件。

## 联系方式

如有问题或建议，欢迎通过以下方式联系：

- GitHub Issues：https://github.com/your-username/open-drive/issues
- 电子邮件：your-email@example.com

---

感谢使用 Open Drive！