RSS Hub使用经验

一、RSS Hub的使用

力求简单，能用图形界面操作的就用图形界面操作。

1. Fork RSS Hub仓库到自己的GitHub账号下
2. 将自己的RSS Hub仓库中download或clone到本地
3. 进入到项目文件夹中，在本地部署RSSHub环境
   1. 安装依赖。执行如下命令：

      npm install

      或

      yarn

      执行上述命令的前提时你已经在计算机上安装了npm或yarn，具体安装过程不赘述。

      注意：

      • 安装后记得配置全局变量、然后重启项目终端。
      • npm安装速度缓慢，不太推荐。
      • 有些依赖只兼容python 2.x 。如果没有Python 2.x ，在安装过程中会抛出Error，但实测不影响使用
   2. 启动RSS Hub开发环境。

      npm run dev
      

      或

      yarn dev

   3. 在浏览器上打开链接：localhost:1200，显示RssHub界面即部署成功。
4. 添加脚本路由。修改RSSHub>lib路径下的router.js文件，向其中添加路由信息此处可仿照已有路由进行修改，例如：

   //其中get函数的第一项是在浏览器上访问的路径，此路径是位于RSS Hub服务器中的相对路径，正式访问时还需再前面加上：（远程）https://rsshub.app 或（本地）localhost:1200。
   //:type?-值传递给路径的参数信息，如键入https://rsshub.app/upc/main/notice，服务器端就可以通过脚本文件中的参数解析获取到notice，进而可以进行下一步操作。
   //第二项是路由脚本文件的存放路径，当在浏览器中键入https://rsshub.app/upc/main/notice时，它会自动去服务器中的指定路径上寻找脚本文件，此处脚本文件是main.js，指定路径时文件后缀省略。
   router.get('/upc/main/:type?', require('./routes/universities/upc/main'));
   

5. 编写路由脚本文件。根据上面指定的路由脚本文件的路径，创建文件夹和js文件注意：
   • 在编写js文件时需要用到一些前端知识，比如网页元素的获取和处理，此处推荐菜鸟教程。
   • 脚本文件的框架结构在RSS Hub的文档有说明，具体参考RSS Hub-参与我们。
   • 在编写自己的脚本文件时可以参考其他大佬的已经写好的脚本文件，打开里面解析的网页，看一下他是怎么获取并解析网页信息的，然后仿造着用到自己想要解析的网页上就可以了。避免重复造轮子，这样能够极大的节省开发时间。
6. 添加脚本的说明文档。修改/doc/路径下对应的markdown文档，如/doc/university.md。注意：
   • 样例可参考RSS Hub-参与我们。
   • 务必将<Route>标签封闭，否则检查不通过。简单内容用<Route ******/>，复杂内容（带参数表）用<Route *****>参数表</Route>。
   • 添加完毕后，进行代码格式标准化，对其提示的警告和错误信息进行修改。

     npm run format
     

7. 测试。上述操作完成后可在本地测试指定网站的RSS是否生成成功。如访问链接：localhost:1200\upc\main\notice，如果返回xml文件内容则表示生成成功。如提示路由为空，则需检查上面的操作是否有问题。
8. pull request
   • Pull Request，简称pr，指请求仓库原有者拉取本人仓库分支，合并到master分支中。
   • 此处为了简化操作、节省时间-懒，可采用如下方法：
     1. 在自己的github账号上打开已经fork的RSS Hub仓库
     2. 替换自己修改了的文件，上传自己创建的文件夹和文件，其他的保持不变。
     3. 返回仓库主页，点击文件列表上方的pull request按钮。
     4. 指定base repository（目标仓库）和head repository（源仓库），即请求将源仓库合并到目标仓库中，一般保持默认即可。
     5. 点击create pull request即可创建pr请求。
     6. 之后等待仓库原有者审核代码，如有问题，则修改后重复上述步骤。
     7. 没有问题的话，仓库原有者就会将你的分支合并到主分支中
     8. 之后就可以通过rsshub的服务器访问自己创建的rss了。

二、RSS使用

生成RSS 订阅源后，需要搭配RSS 阅读器才能浏览自己心仪的网页内容。

推荐以下阅读器（待补充）：

1. Windows

• irreader

2. MAC

• Reeder

3. Android

• Rolly
• FeedMe