diff --git a/README.md b/README.md index ee98df5..4125b5f 100644 --- a/README.md +++ b/README.md @@ -1,78 +1,75 @@ -# CloudDisk Project +# CloudDisk -## 项目介绍 +一款安全、便捷的跨平台桌面网盘应用 -Electron 跨平台桌面网盘应用 +## 功能特性 + +- ✅ 用户认证 - 注册、登录、修改密码 +- ✅ 文件管理 - 上传、下载、删除、重命名、复制、移动 +- ✅ 文件夹操作 - 创建、进入、返回 +- ✅ 搜索功能 - 快速查找文件 +- ✅ 分享功能 - 链接分享、密码保护、过期设置 +- ✅ 回收站 - 恢复、永久删除、清空 +- ✅ 最近访问 - 快速访问历史文件 +- ✅ 云端同步 - 保持文件同步 +- ✅ 用户统计 - 存储空间使用情况 +- ✅ 主题切换 - 深色/浅色模式 +- ✅ 移动端适配 - 响应式设计 ## 技术栈 ### 前端 -- Electron 28+ (桌面框架) -- React 18 (UI框架) -- TypeScript (类型安全) -- Zustand (状态管理) -- Ant Design 5 (UI组件库) +- Electron 28+ +- React 18 +- TypeScript +- Zustand +- Ant Design 5 ### 后端 -- Node.js 20+ (运行环境) -- Express 4 (Web框架) -- SQLite3 (本地数据库) -- JWT (用户认证) -- Multer (文件上传) +- Node.js 20+ +- Express 4 +- SQLite3 +- JWT -## 功能特性 +## 快速开始 -- ✅ 用户注册/登录 -- ✅ 文件上传/下载/删除 -- ✅ 文件夹管理 -- ✅ 分享功能(密码保护/链接分享) -- 🔄 云端同步 -- ⏳ 离线访问 -- ⏳ 主题切换 - -## 开发指南 - -### 前端开发 +### 安装依赖 ```bash -cd frontend -npm install -npm run dev +cd backend && npm install +cd frontend && npm install ``` -### 后端开发 +### 启动后端 ```bash -cd backend -npm install -npm run dev +cd backend && npm run dev ``` -### 测试 +### 启动前端 ```bash -npm test +cd frontend && npm run dev ``` -## 团队成员 - -| 角色 | 账号 | -|------|------| -| 产品经理 | openclaw_product_manager | -| UI设计师 | openclaw_ui_designer | -| 架构设计师 | openclaw_architecture_designer | -| 前端开发 | openclaw_frontend_developer | -| 后端开发 | openclaw_backend_developer | -| 测试工程师 | openclaw_test_engineer | - -## 目录结构 +## 项目结构 ``` -├── prd/ # 产品需求文档 -├── ui-design/ # UI设计文件 -├── architecture/ # 架构设计文档 -├── frontend/ # 前端代码 -├── backend/ # 后端代码 -└── tests/ # 测试代码 +clouddisk-project/ +├── backend/ # 后端服务 +├── frontend/ # 前端应用 +├── ui-design/ # UI设计稿 +├── architecture/ # 架构文档 +├── prd/ # 产品需求 +└── tests/ # 测试代码 ``` -## Git 仓库 +## 团队 -https://git.liantu.tech/openclaw_product_manager/clouddisk-project +- 产品经理 - openclaw_product_manager +- UI设计师 - openclaw_ui_designer +- 架构设计师 - openclaw_architecture_designer +- 前端开发 - openclaw_frontend_developer +- 后端开发 - openclaw_backend_developer +- 测试工程师 - openclaw_test_engineer + +## License + +MIT