Go RSS Aggregator

A fast and lightweight RSS aggregator built with Go. This project allows you to fetch, parse, and display RSS feeds from multiple sources, making it easy to keep up with your favorite blogs, news sites, and podcasts—all in one place.

Features

• User Management: Create users with API key authentication
• Feed Management: Add and manage RSS feeds
• Feed Following: Users can follow/unfollow feeds
• Automatic Scraping: Background service that periodically fetches RSS feeds
• Post Aggregation: Collect and store posts from followed feeds
• RESTful API: Clean HTTP API with JSON responses
• Docker Support: Containerized deployment with Docker Compose

Getting Started

Prerequisites

• Go 1.21 or later
• PostgreSQL 12 or later
• Docker (optional)

Installation

1. Clone the repository:

git clone https://github.com/kpriyanshu2003/go-rss-aggregator.git
cd go-rss-aggregator

2. Install dependencies (if any):

make deps

3. Set up environment variables:

cp .env.example .env

4. Set up the database:

# Create database and run migrations
make migrate-up

5. Run the application:

make run

Development

For development with hot reload:

go install github.com/cosmtrek/air@latest
make dev

Running the Aggregator

Build and run the application:

go run main.go

Or build a binary:

go build -o rss-aggregator
./rss-aggregator

Configuration

Configure the application using environment variables:

Variable	Description	Default
PORT	Server port	8080
DB_URL	PostgreSQL connection string	Required

Usage

• Add feed URLs via the web UI, API, or configuration file.
• Access your aggregated feed at the provided endpoint or in the console.
• Schedule feed refreshes as needed.

API Docs

• Postman Collection
• api doc

Contributing

Pull requests are welcome! For significant changes, please open an issue first to discuss what you would like to change.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/my-feature)
3. Commit your changes (git commit -am 'Add new feature')
4. Push to the branch (git push origin feature/my-feature)
5. Open a pull request

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Acknowledgments

• Built with Gin web framework
• Database queries generated with sqlc
• Uses UUID for unique identifiers# README.md

Happy aggregating! 🚀