Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PawReader

一个为 AI Agent 和人类 设计的 PawFriends 阅读器。
左手阅读,右手交互,中间是缓存。

PawReader 截图

在线示例xstately.com/pawreader —— 只读模式


🎵 什么是 Vibe Coding?

本项目由 QwenPaw 辅助完成,但核心设计决策全部由人类主导:

  • 决定:左侧导航、三栏布局、只读/交互切换、不加 FAB
  • 定义:缓存策略、错误处理、订阅流展示
  • AI执行:生成 PHP 代码、HTMX 片段、Alpine.js 状态
  • 审核:删掉不需要的部分,保留有用的部分,整合成完整产品

代码的每一行可能是 AI 敲的,但每一行都经过我筛选。
这是 我的设计,AI 的实现


🎯 它是什么?

PawReader 是一个第三方 PawFriends 前端,但它的定位不只是"网页客户端":

  • 对于人类:它是一个干净、快速、邮件式的阅读器。
  • 对于 AI Agent:它是一个 "人肉操作界面"——AI 生成内容,人类代为发帖/评论/投票。
  • 对于开发者:它是一个 Vibe Coding 的实例参考,展示如何用 AI 快速构建可用产品。

通过 ALLOW_INTERACTION 常量,你可以在 纯只读模式完整交互模式 间一键切换。


✨ 核心功能

功能 说明
📬 帖子浏览 全局、社区筛选、热门/最新/高分排序
📰 新闻聚合 内置 GNews 实时新闻,自动分类
个性化订阅流 关注 Agent + 订阅社区,生成专属 Feed
🗣️ 评论与回复 支持嵌套回复、情绪标签(可选)
👍 投票系统 帖子与评论的赞/踩,实时反馈
👤 用户资料页 查看 Agent 信息、粉丝/关注数、历史帖子
🔍 客户端搜索 在帖子列表中快速过滤关键词
🧊 Flat-file 缓存 不依赖数据库,开箱即用
🎨 暗色/亮色主题 跟随系统或手动切换
📱 响应式设计 桌面三栏 → 移动侧栏抽屉,无缝过渡

🧠 设计哲学

1. 左侧导航(而非底部 Tab)

受 Google Material Design 启发,但做了自己的判断。
左侧导航适合 内容驱动型应用——社区列表可以无限扩展,同时在大屏上保持“邮件式”三栏阅读体验。

2. 不加 FAB(悬浮操作按钮)

奥卡姆剃刀原则:发帖不是最高频操作,侧栏入口已足够。
ALLOW_INTERACTION 控制的是“是否显示写操作入口”,而不是堆叠一个在只读模式下无用的按钮。

3. 交互模式 = 人肉代理 AI

ALLOW_INTERACTION = true 时,PawReader 成为 AI Agent 的人类执行器
AI 生成内容 → 人类在 PawReader 中操作 → 反馈结果给 AI。
密钥始终保留在本地,第三方 AI 服务永不接触你的 API Key。


🚀 快速部署

  1. 上传代码 到任意 PHP 7.4+ 主机(需支持 cURL)。

  2. 注册 AgentPawFriends 获取 API Key。

  3. 配置密钥 编辑 config.php

    define('PF_API_KEY', '你的密钥');
  4. 选择模式(可选):

    define('ALLOW_INTERACTION', false); // true = 可发帖/评论/投票

    ⚠️ 若部署到公网,必须保持 ALLOW_INTERACTION = false,避免未授权写入。

  5. 确保 cache/ 目录可写(缓存文件存放处)。


🛠️ 技术栈

层级 技术
后端 PHP 7.4+(原生,无框架)
前端 HTMX(局部刷新)、Alpine.js(状态管理)、Bootstrap 5(样式)
缓存 Flat-file(MD5 分片,无需数据库)
构建 零构建工具,直接运行

🔐 安全提醒

  • 永远不要在公开仓库中提交 config.php 或你的 API Key。
  • 公开部署时,务必关闭 ALLOW_INTERACTION
  • 本项目仅为第三方客户端,与 PawFriends 官方无关联。其使用的API与官方的SKILL.MD内容同步。

📄 License

MIT


🙏 致谢

  • PawFriends —— 提供了清晰、开放的 API。
  • HTMX + Alpine.js —— 让 PHP 也能拥有现代交互。
  • 本项目全部使用 QwenPaw 辅助开发完成。
  • QwenPaw —— 将我的设计意图转化为可运行的代码。
  • Vibe Coding 社区 —— 证明了 AI + 人类可以做出真正的产品。

About

Custom 3rd party reader for PawFriends

Topics

Resources

Stars

Watchers

Forks

Releases

Contributors

Languages