Rebrand project to KatelyaTV, update docs and release notes
Co-authored-by: 20250410303 <20250410303@stu.fosu.edu.cn>pull/5/head
Cursor Agent
parent
60b1042a29
commit
a9bd8e47e1
|
|
@ -1,6 +1,6 @@
|
|||
# 更新日志
|
||||
|
||||
本文档记录了 MoonTV 项目的所有重要更改。
|
||||
本文档记录了 KatelyaTV 项目的所有重要更改。KatelyaTV 为在「MoonTV」基础上的二创与继承版本，延续上游核心能力并持续修复优化。
|
||||
|
||||
## [未发布]
|
||||
|
||||
|
|
@ -11,7 +11,7 @@
|
|||
- 社交分享功能
|
||||
- 用户评分系统
|
||||
|
||||
## [0.1.0] - 2025-01-XX
|
||||
## [0.1.0-katelya] - 2025-01-XX
|
||||
|
||||
### ✨ 新功能
|
||||
- 🎬 多源聚合搜索系统，集成20+个免费资源站点
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# 贡献指南
|
||||
|
||||
感谢您对 MoonTV 项目的关注！我们欢迎所有形式的贡献，包括但不限于：
|
||||
感谢您对 KatelyaTV 项目的关注！我们欢迎所有形式的贡献，包括但不限于：
|
||||
|
||||
- 🐛 报告 Bug
|
||||
- 💡 提出新功能建议
|
||||
|
|
@ -23,8 +23,8 @@
|
|||
```bash
|
||||
# 在 GitHub 上 Fork 本仓库
|
||||
# 然后克隆到本地
|
||||
git clone https://github.com/YOUR_USERNAME/moontv.git
|
||||
cd moontv
|
||||
git clone https://github.com/YOUR_USERNAME/katelyatv.git
|
||||
cd katelyatv
|
||||
```
|
||||
|
||||
2. **安装依赖**
|
||||
|
|
@ -114,7 +114,7 @@ git commit -m "test: 添加播放记录 API 测试用例"
|
|||
|
||||
在提交 Bug 报告之前，请：
|
||||
|
||||
1. 搜索现有的 [Issues](https://github.com/senshinya/moontv/issues)
|
||||
1. 搜索现有的 Issues（仓库 Issues 页面）
|
||||
2. 检查是否已有相关报告
|
||||
3. 使用 Bug 报告模板
|
||||
|
||||
|
|
@ -153,7 +153,7 @@ git commit -m "test: 添加播放记录 API 测试用例"
|
|||
|
||||
在提出功能建议之前，请：
|
||||
|
||||
1. 搜索现有的 [Discussions](https://github.com/senshinya/moontw/discussions)
|
||||
1. 搜索现有的 Discussions（仓库 Discussions 页面）
|
||||
2. 检查是否已有相关讨论
|
||||
3. 使用功能建议模板
|
||||
|
||||
|
|
@ -349,11 +349,11 @@ pnpm start
|
|||
### Docker 测试
|
||||
|
||||
```bash
|
||||
# 构建 Docker 镜像
|
||||
docker build -t moontv:test .
|
||||
# 构建 Docker 镜像（镜像名示例）
|
||||
docker build -t katelyatv:test .
|
||||
|
||||
# 运行容器
|
||||
docker run -d --name moontv-test -p 3000:3000 --env PASSWORD=test123 moontv:test
|
||||
docker run -d --name katelyatv-test -p 3000:3000 --env PASSWORD=test123 katelyatv:test
|
||||
```
|
||||
|
||||
## 📞 获取帮助
|
||||
|
|
@ -367,7 +367,7 @@ docker run -d --name moontv-test -p 3000:3000 --env PASSWORD=test123 moontv:test
|
|||
|
||||
## 🎉 致谢
|
||||
|
||||
感谢所有为 MoonTV 项目做出贡献的开发者！
|
||||
感谢所有为 KatelyaTV 项目做出贡献的开发者！
|
||||
|
||||
您的贡献让这个项目变得更好。无论是代码、文档、测试还是反馈，我们都非常感激。
|
||||
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
# 📊 MoonTV 项目状态报告
|
||||
# 📊 KatelyaTV 项目状态报告
|
||||
|
||||
## 🎯 项目概述
|
||||
|
||||
**MoonTV** 是一个功能完整的影视聚合播放器，基于现代 Web 技术栈构建，支持多平台部署和多种存储后端。
|
||||
**KatelyaTV** 是一个功能完整的影视聚合播放器，基于现代 Web 技术栈构建，支持多平台部署和多种存储后端。该项目为在原始项目「MoonTV」基础上的二创与继承版本，延续其优秀架构并在此之上进行持续优化与维护。
|
||||
|
||||
**当前版本**: v0.1.0
|
||||
**当前版本**: v0.1.0-katelya
|
||||
**最后更新**: 2025-01-XX
|
||||
**项目状态**: 🟢 生产就绪
|
||||
|
||||
|
|
@ -193,7 +193,7 @@
|
|||
|
||||
## 🎉 总结
|
||||
|
||||
MoonTV 项目目前处于**生产就绪**状态，核心功能完整，技术架构成熟，用户体验优秀。项目具备以下特点：
|
||||
KatelyaTV 项目目前处于**生产就绪**状态，核心功能完整，技术架构成熟，用户体验优秀。项目具备以下特点：
|
||||
|
||||
- ✅ **功能完整**: 所有核心功能均已实现
|
||||
- ✅ **技术先进**: 使用最新的 Web 技术
|
||||
|
|
@ -203,6 +203,8 @@ MoonTV 项目目前处于**生产就绪**状态，核心功能完整，技术架
|
|||
|
||||
项目可以安全地用于生产环境，适合个人用户和中小型团队使用。
|
||||
|
||||
> 注：KatelyaTV 基于 MoonTV 二创与继承开发，保留并致谢原作者与社区贡献；如有授权或版权问题，请联系以尽快处理。
|
||||
|
||||
---
|
||||
|
||||
**最后更新**: 2025-01-XX
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# 🚀 MoonTV 快速开始指南
|
||||
# 🚀 KatelyaTV 快速开始指南
|
||||
|
||||
欢迎使用 MoonTV！本指南将帮助您在几分钟内完成部署和配置。
|
||||
欢迎使用 KatelyaTV！本指南将帮助您在几分钟内完成部署和配置。
|
||||
|
||||
## 📋 前置要求
|
||||
|
||||
|
|
@ -13,12 +13,12 @@
|
|||
### 1. 快速启动
|
||||
|
||||
```bash
|
||||
# 拉取最新镜像
|
||||
# 拉取最新镜像（当前镜像沿用上游命名空间）
|
||||
docker pull ghcr.io/senshinya/moontv:latest
|
||||
|
||||
# 启动容器
|
||||
docker run -d \
|
||||
--name moontv \
|
||||
--name katelyatv \
|
||||
-p 3000:3000 \
|
||||
--env PASSWORD=your_password \
|
||||
--restart unless-stopped \
|
||||
|
|
@ -33,10 +33,10 @@ docker run -d \
|
|||
|
||||
```bash
|
||||
# 停止容器
|
||||
docker stop moontv
|
||||
docker stop katelyatv
|
||||
|
||||
# 删除容器
|
||||
docker rm moontv
|
||||
docker rm katelyatv
|
||||
```
|
||||
|
||||
## 🌐 云平台部署
|
||||
|
|
@ -224,13 +224,13 @@ NEXT_PUBLIC_STORAGE_TYPE=d1
|
|||
## 📞 获取帮助
|
||||
|
||||
- 📖 [完整文档](README.md)
|
||||
- 🐛 [问题反馈](https://github.com/senshinya/moontv/issues)
|
||||
- 💬 [功能讨论](https://github.com/senshinya/moontv/discussions)
|
||||
- 🐛 问题反馈：在仓库 Issues 页面提交
|
||||
- 💬 功能讨论：在 Discussions 页面参与
|
||||
- 📝 [更新日志](CHANGELOG.md)
|
||||
|
||||
## 🎉 开始使用
|
||||
|
||||
现在您已经完成了基础配置，可以开始享受 MoonTV 带来的影视体验了！
|
||||
现在您已经完成了基础配置，可以开始享受 KatelyaTV 带来的影视体验了！
|
||||
|
||||
**重要提醒：**
|
||||
- 本项目仅供学习和个人使用
|
||||
|
|
|
|||
|
|
@ -0,0 +1,53 @@
|
|||
# KatelyaTV v0.1.0-katelya 发布说明
|
||||
|
||||
> 本项目在「MoonTV」基础上进行二创与继承，由 Katelya 持续维护。保留并致谢原作与社区贡献，在不改变核心理念的前提下，专注于更易部署、更友好体验与更稳定维护。
|
||||
|
||||
## 亮点
|
||||
- 全面延续上游核心：多源聚合搜索、在线播放、收藏与观看历史、PWA 支持、响应式布局、多用户系统等
|
||||
- 文档重写与梳理：README、QUICKSTART、PROJECT_STATUS、CONTRIBUTING、CHANGELOG 全面适配 KatelyaTV 品牌
|
||||
- 部署指引优化：Vercel / Docker / Cloudflare Pages 一站式说明，提供 Compose 最佳实践
|
||||
- 安全与隐私提醒：新增部署安全提示与法律风险说明
|
||||
|
||||
## 变更摘要
|
||||
- 品牌与文档
|
||||
- 将项目品牌统一为 KatelyaTV，并明确二创与继承来源
|
||||
- 更新部署与使用说明，优化快速上手体验
|
||||
- 调整仓库路径、示例命令与 Docker 镜像示例名称（镜像仍沿用上游命名空间）
|
||||
- 代码与配置
|
||||
- 保持与上游 MoonTV 的接口与行为兼容
|
||||
- 默认站点名改为 `KatelyaTV`（可通过 `SITE_NAME` 环境变量覆盖）
|
||||
|
||||
## 安装与升级
|
||||
- 首次安装（Docker 推荐）
|
||||
```bash
|
||||
# 拉取镜像（当前仍沿用上游命名空间）
|
||||
docker pull ghcr.io/senshinya/moontv:latest
|
||||
|
||||
# 启动示例
|
||||
docker run -d --name katelyatv \
|
||||
-p 3000:3000 \
|
||||
--env PASSWORD=your_password \
|
||||
--restart unless-stopped \
|
||||
ghcr.io/senshinya/moontv:latest
|
||||
```
|
||||
- 或使用 README 中的 Docker Compose 示例
|
||||
|
||||
## 兼容性
|
||||
- 保持与上游 MoonTV v0.1.0 行为一致
|
||||
- 支持存储后端：localStorage / Redis / Cloudflare D1 / Upstash Redis
|
||||
- 运行环境：Node.js 18+；容器镜像支持多架构
|
||||
|
||||
## 已知问题
|
||||
- 部分第三方资源站可用性受其自身状态影响
|
||||
- Android TV 端收藏与网页端暂未完全互通（后续版本优化）
|
||||
|
||||
## 后续路线
|
||||
- 弹幕系统、字幕支持、下载功能、社交分享
|
||||
- 数据同步与多端互通完善
|
||||
- 性能与稳定性持续优化
|
||||
|
||||
## 鸣谢
|
||||
- 原始项目 MoonTV 及其作者与社区
|
||||
- 所有为本项目提供反馈、贡献代码与文档的开发者
|
||||
|
||||
— Katelya
|
||||
Loading…
Reference in New Issue