html2rss-web

This web application scrapes websites to build and deliver RSS 2.0 feeds.

🌐 Community & Resources

Resource	Description	Link
📚 Documentation & Feed Directory	Complete guides, tutorials, and browse 100+ pre-built feeds	html2rss.github.io
💬 Community Discussions	Get help, share ideas, and connect with other users	GitHub Discussions
📋 Project Board	Track development progress and upcoming features	View Project Board
💖 Support Development	Help fund ongoing development and maintenance	Sponsor on GitHub

Quick Start Options:

• New to RSS? → Start with the web application guide
• Need a specific feed? → Browse the feed directory
• Want to deploy? → Check out deployment guides
• Want to contribute? → See our contributing guide

Features:

• Provides stable URLs for feeds generated by automatic sourcing.
• Create your custom feeds!
• Comes with plenty of included configs.
• Handles request caching.
• Sets caching-related HTTP headers.

The functionality of scraping websites and building the RSS feeds is provided by the Ruby gem html2rss.

Documentation

For full documentation, please see the html2rss-web documentation.

Development

Quick Start with GitHub Codespaces

The easiest way to get started is using GitHub Codespaces:

1. Fork this repository
2. Click "Code" → "Codespaces" → "Create codespace on [your-username]/html2rss-web"
3. Wait for the codespace to build (it will automatically run bundle install)
4. The development server will be available at the forwarded port (usually 3000)

Local Development

1. Clone and setup:

   git clone https://github.com/html2rss/html2rss-web.git
   cd html2rss-web
   make setup

2. Start development server:

   make dev

The application will be available at http://localhost:3000.

Development Commands

Command	Description
make help	Show all available commands
make setup	Full development setup
make dev	Start development server
make test	Run tests
make lint	Run linter
make fix	Auto-fix linting issues
make clean	Clean temporary files

Contributing

Contributions are welcome! Please see the contributing guide for more information.

Sponsoring

If you find this project useful, please consider sponsoring the project.