Skip to content

MichealZJQ/web-rss

Repository files navigation

SmartReader

自托管、AI 驱动的 RSS 阅读器

中文 | English

Python 3.11 Vue 3 MIT License Docker Compose


自托管、AI 驱动的 RSS 阅读器,采用简洁三栏布局。

基于 FastAPI + Vue 3 构建,Docker 一键部署。

功能特性

  • RSS 订阅管理 — 添加、分组、自动刷新订阅源;支持 OPML 导入导出
  • 三栏阅读布局 — 侧边栏订阅源、文章列表、内容预览同屏展示
  • 全文自动补抓 — RSS 内容不足时自动抓取原文;特别支持微信公众号文章
  • AI 智能功能 — 摘要生成、智能问答、关键词提取、分类、翻译、情感分析(兼容 OpenAI API)
  • AI 热点资讯 — 实时代理 AI 行业热点,内置 TTL 缓存
  • 全文搜索 — 快速搜索所有文章内容
  • 播客 / 视频 — 媒体自动检测,播放进度跟踪
  • 多主题 — 亮色、暗色、护眼、高对比度、极光、海洋、暖色 7 种主题
  • 国际化 — 中文 / 英文
  • PWA — 可安装为桌面或移动端应用
  • 单用户模式 — 预置管理员账号,无需注册

技术栈

层级 技术
后端 Python 3.11 · FastAPI · SQLAlchemy · aiosqlite/aiomysql · APScheduler
前端 Vue 3 · TypeScript · Element Plus · Pinia · Vite
AI OpenAI 兼容 API(OpenAI、DeepSeek、通义千问等)
部署 Docker Compose · Nginx · RSSHub

快速开始

Docker Compose(推荐)

git clone https://github.com/MichealZJQ/web-rss.git
cd web-rss

# 启动所有服务(后端 + 前端 + RSSHub)
docker compose up -d

打开 http://localhost,使用 admin / admin123 登录。

首次登录后请在 设置 → 安全 中修改默认密码。

手动安装

环境要求: Python 3.11+、Node.js 20+

# 1. 后端
cd backend
python -m venv venv && source venv/bin/activate
pip install -r requirements.txt
cp .env.example .env          # 按需编辑
uvicorn app.main:app --reload

# 2. 前端
cd ../frontend
npm install
npm run dev

前端开发服务器运行在 http://localhost:5001,API 代理到后端 :8000

配置说明

所有配置通过环境变量或 backend/.env 管理,详见 backend/.env.example

变量 默认值 说明
SECRET_KEY (生产必填) 应用密钥
JWT_SECRET_KEY (生产必填) JWT 签名密钥
DATABASE_URL sqlite+aiosqlite:///./data/rss.db 数据库地址(SQLite 或 MySQL)
AI_API_KEY AI API 密钥(可选,不填则 AI 功能禁用)
AI_API_BASE https://api.openai.com/v1 AI API 地址
AI_MODEL gpt-3.5-turbo AI 模型名称
ADMIN_USERNAME admin 管理员用户名(首次启动自动创建)
ADMIN_PASSWORD admin123 管理员密码
RSSHUB_INSTANCES (内置列表) RSSHub 实例地址,逗号分隔

项目结构

web-rss/
├── backend/
│   ├── app/
│   │   ├── api/            # API 路由
│   │   ├── models/         # SQLAlchemy 模型
│   │   ├── schemas/        # Pydantic 模式
│   │   ├── services/       # 业务逻辑(RSS 抓取、AI 等)
│   │   └── config.py       # 配置管理
│   ├── Dockerfile
│   └── requirements.txt
├── frontend/
│   ├── src/
│   │   ├── pages/          # 页面组件
│   │   ├── components/     # 通用组件
│   │   ├── stores/         # Pinia 状态管理
│   │   ├── services/       # API 客户端
│   │   └── assets/styles/  # SCSS 样式与主题
│   ├── Dockerfile
│   └── nginx.conf
├── docker-compose.yml
├── README.md               # 中文文档
├── README_EN.md             # English
├── DEPLOY.md                # 中文部署指南
└── DEPLOY_EN.md             # Deployment Guide

部署

详见 部署指南

许可证

MIT

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors