Skip to content

RSS-proxy allows you to do create an RSS or ATOM feed of almost any website, just by analyzing just the static HTML structure.

Notifications You must be signed in to change notification settings

minakami-akihiro/rss-proxy

 
 

Repository files navigation

RSS-proxy

RSS-proxy is a tool that allows you to do create an RSS/ATOM or JSON feed of almost any website, purely by analyzing just the static HTML structure. Try the live demo.

Playground

Quickstart using docker

The simplest way to use RSS-proxy is using docker

docker pull damoeb/rss-proxy
docker run -p 3000:3000 -it damoeb/rss-proxy

Then open localhost:3000 in the browser.

JavaScript Support

rss-proxy supports dynamic webapps in a separate docker image damoeb/rss-proxy:js cause it is with 1GB quite large. Running this image will render a checkbox in the User Interface to pre-render a website in a headless browser, rather than using the static response.

docker pull damoeb/rss-proxy:js
docker run -p 3000:3000 -it damoeb/rss-proxy:js

Developing RSS-proxy

The project is separated into three modules

  • core: the feed parser logic, plain JavaScript
  • playground: the web app to visualize and explore feed generation
  • proxy: the expressjs server

For local development you need node 12+. Then follow these steps:

  • Install all npm dependencies
npm run install

  • Start server
cd packages/proxy && npm run start

  • Start client
cd packages/playground && npm run start

Troubleshooting

See troubleshooting.

Changelog

See changelog.

Related Projects

License

This project uses the following license: GNU GPLv3.

About

RSS-proxy allows you to do create an RSS or ATOM feed of almost any website, just by analyzing just the static HTML structure.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • HTML 83.5%
  • TypeScript 14.8%
  • Other 1.7%