infomate.club

项目介绍：Infomate.club

项目概述

Infomate.club 是一个小型的网页服务，旨在将多个RSS源整合在一个页面上显示，并使用TextRank算法进行复杂的解析和文章摘要。通过它，用户无需订阅大量的媒体账号，也不必忍受频繁的通知，就能轻松获取不同领域的新闻资讯。

此外，Infomate还提供了以主题或人物为基础的资讯合集，帮助用户发现新的信息来源。这种合集能有效帮助我们跳出信息泡沫，因为我们常常存在偏见。

项目特点

Infomate.club 是一个业余项目，创建者在一个周末完成了其最小可行产品（MVP）。因此，该项目不具备高级的容器化技术支持或是复杂的架构模式，也没有进行测试。其存在的目的是展示一个宠物项目（pet-project）可能的样子，所以期望值不宜过高。

工作原理

Infomate.club 本质上是一个使用 Django 开发的网络应用程序，与几个用于RSS解析的脚本结合工作。项目使用 PostgreSQL 数据库来存储解析的数据，通过网页应用展示这些数据（大量地使用缓存）。数据解析和更新通过在计划任务（cron）中运行的三个脚本来完成。

项目使用了 Feedparser 和 BeautifulSoup 来查找、下载和解析RSS数据。同时，项目中还使用 newspaper3k 进行文本摘要，并进行了一些额外保护以避免处理不佳的内容（如播客和过大的页面）导致的内存消耗问题。

本地运行

要在本地运行项目，可以采取以下简单步骤：

1. 在计算机上安装 Docker。
2. 克隆项目仓库：git clone git@github.com:vas3k/infomate.club.git
3. 进入项目目录并构建：cd infomate.club，docker-compose up --build

在首次运行时，请等待 "migrate_and_init" 容器完成其数据库初始化的任务。随后，即可在喜爱的浏览器中打开 localhost:8000 进行使用。

若遇到问题或需要完全终止运行，可在另外一个终端中使用以下命令：

docker-compose down --remove-orphans

数据格式

所有的资讯合集与RSS源信息均储存在一个名为 boards.yml 的文件中，这是项目中管理新信息的唯一入口。

生产环境

项目部署通过简单的 Github Action 进行，该动作会在每次推送到主分支时被触发。要自行设置，需在仓库SECRETS中添加一些常量，如服务器地址、Github Token、SSH信息等。记得为该应用设置 Nginx 代理（添加 SSL 等）。

贡献指南

欢迎大家提交 Pull Requests。如果有重大更改，请先开启 issue 讨论变动内容。项目并没有严格的格式规则，只需说明你的动机和更改，以便其他人理解。

开源许可证

该项目使用 Apache 2.0 许可证，这意味着您可以对项目进行修改、分发和商业使用，但必须注明原作者或提供服务链接。