rss-feed-agg

module
v0.0.0-...-252d32f Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 24, 2024 License: MIT

README ΒΆ

Feedoku

Feedoku is a modern RSS Feed aggregator built with Next.js, Go, Postgres, Redis, and Kafka. It allows users to aggregate, manage, and read their favorite RSS feeds in one place.

πŸš€ Features

  • Real-time feed updates using Kafka
  • Fast content delivery with Redis caching
  • Responsive web interface built with Next.js
  • RESTful API powered by Go
  • Feed management and organization
  • Search functionality across all feeds
  • Mobile-friendly interface

πŸ› οΈ Tech Stack

  • Frontend: Next.js
  • Backend: Go (Golang)
  • Cache: Redis
  • Message Broker: Apache Kafka
  • Database: PostgreSQL

πŸ”§ Installation

  1. Clone the repository:
git clone https://github.com/codebyaadi/feedoku.git
cd feedoku
  1. Set up the frontend:
cd www
npm install
cp .env.example .env
# Configure your environment variables
  1. Set up the backend: (work in main directory)
cp .env.example .env
# Configure your environment variables
  1. Start Redis:
redis-server
  1. Start Kafka:
# Start Zookeeper first
bin/zookeeper-server-start.sh config/zookeeper.properties

# Start Kafka
bin/kafka-server-start.sh config/server.properties

πŸš€ Running the Application

  1. Start the frontend development server:
cd frontend
npm run dev
  1. Start the backend server: (work in main directory)
go run main.go

🀝 Contributing

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

πŸ“ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸ‘₯ Authors

πŸ™ Acknowledgments

  • Thanks to all contributors
  • Inspired by various RSS readers and aggregators
  • Built with amazing open source technologies

Directories ΒΆ

Path Synopsis
internal
rss

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL