一个现代化的Private Tracker资源分享平台，专注于高质量资源分享和社区建设
## 📋 目录 - [项目简介](#项目简介) - [功能特性](#功能特性) - [技术栈](#技术栈) - [快速开始](#快速开始) - [项目结构](#项目结构) - [API文档](#api文档) - [开发指南](#开发指南) - [贡献指南](#贡献指南) - [许可证](#许可证) ## 🎯 项目简介 StarRypt是一个现代化的PT（Private Tracker）资源分享平台，旨在为用户提供高质量的资源分享体验。平台集成了种子管理、社区论坛、积分系统、话题广场等功能，打造完整的资源分享生态系统。 ### 🌟 项目亮点 - 🎨 **现代化UI设计** - 基于React的响应式界面设计 - 🔐 **安全认证体系** - JWT Token认证，支持邀请码注册 - ⭐ **完善积分系统** - 星币、魔力值双积分体系，等级进阶 - 💬 **活跃社区功能** - 论坛、话题广场、评论互动 - 📱 **移动端友好** - 完全响应式设计，完美适配移动设备 - 🚀 **高性能架构** - 前后端分离，支持高并发访问 ## ✨ 功能特性 ### 🔐 用户系统 - [x] 用户注册/登录（支持邀请码） - [x] 个人资料管理 - [x] 用户等级系统 - [x] 上传/下载历史记录 - [x] 邀请码管理 ### 🌱 种子管理 - [x] 种子上传/下载 - [x] 种子搜索和分类 - [x] 种子详情展示 - [x] 热门种子推荐 - [x] 种子评论和点赞 ### ⭐ 积分系统 - [x] 星币和魔力值双积分 - [x] 每日签到奖励 - [x] 积分兑换上传量 - [x] 用户等级和头衔 - [x] 分享率统计 ### 💬 社区功能 - [x] 论坛主题发布和回复 - [x] 话题广场 - [x] 全球广播系统 - [x] 用户互动（点赞、评论） - [x] 内容搜索功能 ### 📢 管理功能 - [x] 公告系统 - [x] 分类管理 - [x] 内容审核 - [x] 用户权限管理 ## 🛠 技术栈 ### 前端技术 - **框架**: React 18.x - **路由**: React Router DOM - **状态管理**: Context API + localStorage - **UI组件**: 自定义组件库 - **样式**: CSS3 + Flexbox/Grid - **图标**: Font Awesome - **构建工具**: Create React App ### 后端技术 (规划中) - **运行时**: Node.js 16+ - **框架**: Express.js - **数据库**: MongoDB / PostgreSQL - **认证**: JWT Token - **文件存储**: 本地存储 / 云存储 ### 开发工具 - **版本控制**: Git - **代码规范**: ESLint + Prettier - **包管理**: npm - **API文档**: 详细的Markdown文档 ## 🚀 快速开始 ### 环境要求 - Node.js 16.x 或更高版本 - npm 8.x 或更高版本 - 现代浏览器 (Chrome 90+, Firefox 88+, Safari 14+) ### 安装步骤 1. **克隆项目** ```bash git clone https://github.com/your-org/starrypt.git cd starrypt ``` 2. **安装依赖** ```bash npm install ``` 3. **启动开发服务器** ```bash npm start ``` 4. **访问应用** ``` 打开浏览器访问: http://localhost:3000 ``` ### 构建生产版本 ```bash # 构建生产版本 npm run build # 预览生产版本 npm run preview ``` ## 📁 项目结构 ``` starrypt/ ├── public/ # 静态资源 │ ├── index.html # HTML模板 │ └── favicon.ico # 网站图标 ├── src/ # 源代码 │ ├── assets/ # 静态资源 │ │ └── images/ # 图片资源 │ ├── components/ # 可复用组件 │ │ ├── TorrentList/ # 种子列表组件 │ │ ├── Upload/ # 上传组件 │ │ └── UserPanel/ # 用户面板组件 │ ├── config/ # 配置文件 │ ├── pages/ # 页面组件 │ │ ├── TorrentDetail/ # 种子详情页 │ │ └── ... │ ├── services/ # API服务 │ │ ├── auth.js # 认证服务 │ │ ├── torrents.js # 种子服务 │ │ ├── users.js # 用户服务 │ │ └── ... │ ├── utils/ # 工具函数 │ │ └── localStorage.js # 本地存储工具 │ ├── App.js # 应用主组件 │ └── index.js # 应用入口 ├── api.md # API接口文档 ├── package.json # 项目配置 └── README.md # 项目说明 ``` ## 📚 API文档 详细的API接口文档请查看 [api.md](./api.md) ### 接口概览 - 🔐 **认证系统** (4个接口) - 登录、注册、用户信息 - 👤 **用户管理** (5个接口) - 用户资料、统计、历史记录 - 🌱 **种子管理** (9个接口) - 上传、下载、搜索、分类 - ⭐ **积分系统** (6个接口) - 积分、签到、兑换、等级 - 💬 **社区功能** (22个接口) - 论坛、话题、广播、评论 - 📂 **系统管理** (9个接口) - 分类、邀请码、公告 ### 开发状态 - ✅ **已实现**: 3个接口 - 🟡 **部分实现**: 4个接口 - 🔴 **待实现**: 47个接口 - 🔵 **前端模拟**: 1个接口 ## 🛠 开发指南 ### 开发环境配置 1. **安装开发工具** ```bash # 安装全局工具 npm install -g create-react-app # 安装项目依赖 npm install ``` 2. **环境变量配置** ```bash # 创建环境变量文件 cp .env.example .env.local # 编辑环境变量 REACT_APP_API_BASE_URL=http://localhost:3001 REACT_APP_APP_NAME=StarRypt ``` ### 代码规范 - **组件命名**: 使用PascalCase (如: `TorrentList`) - **文件命名**: 组件文件使用PascalCase，其他文件使用camelCase - **样式规范**: 使用CSS Modules或styled-components - **提交规范**: 遵循Conventional Commits ### 开发流程 1. **功能开发** - 创建功能分支: `git checkout -b feature/功能名称` - 开发并测试功能 - 提交代码: `git commit -m "feat: 添加xxx功能"` 2. **API接口开发** - 同步更新API文档 (api.md) - 更新接口状态标识 - 添加完整的JSON示例 3. **代码审查** - 创建Pull Request - 代码审查通过后合并 ### 测试指南 ```bash # 运行单元测试 npm test # 运行集成测试 npm run test:integration # 生成测试覆盖率报告 npm run test:coverage ``` ## 🤝 贡献指南 我们欢迎所有形式的贡献！请遵循以下步骤： ### 贡献流程 1. **Fork项目** 到你的GitHub账户 2. **创建功能分支**: `git checkout -b feature/AmazingFeature` 3. **提交更改**: `git commit -m 'feat: Add some AmazingFeature'` 4. **推送分支**: `git push origin feature/AmazingFeature` 5. **创建Pull Request** ### 提交信息规范 ``` 类型(范围): 简短描述 详细描述 (可选) 相关Issue: #123 ``` **提交类型**: - `feat`: 新功能 - `fix`: 修复bug - `docs`: 文档更新 - `style`: 代码格式调整 - `refactor`: 代码重构 - `test`: 测试相关 - `chore`: 构建工具或辅助工具的变动 ### 问题反馈 - 🐛 **Bug报告**: 使用Bug模板创建Issue - 💡 **功能建议**: 使用Feature模板创建Issue - ❓ **使用问题**: 在Discussions中提问 ## 📊 项目状态 ### 开发进度 - 🎨 **前端界面**: 85% 完成 - 🔧 **前端功能**: 90% 完成 - 🌐 **后端API**: 15% 完成 - 🧪 **测试用例**: 30% 完成 - 📖 **文档**: 95% 完成 ### 里程碑 - [x] **v0.1.0** - 基础界面和前端模拟功能 - [x] **v0.2.0** - 用户系统和种子管理 - [x] **v0.3.0** - 社区功能和积分系统 - [ ] **v1.0.0** - 后端API完整实现 (目标) - [ ] **v1.1.0** - 性能优化和功能完善 ## 📄 许可证 本项目采用 MIT 许可证。详情请查看 [LICENSE](LICENSE) 文件。 ## 👥 团队 - **项目负责人**: 星域PT开发团队 - **前端开发**: React团队 - **后端开发**: Node.js团队 - **UI/UX设计**: 设计团队 ## 🙏 致谢 感谢所有为这个项目做出贡献的开发者和用户！ 特别感谢: - React开源社区 - 各种优秀的开源库和工具 - 测试用户的反馈和建议Made with ❤️ by StarRypt Team
如果这个项目对你有帮助，请给我们一个 ⭐