Ogugu

Ogugu is a backend application for an RSS feed aggregator and reader. It allows users to add RSS feed URLs to a centralized database, subscribe to multiple feeds, and regularly fetch and aggregate new posts from these feeds for seamless consumption.

Features

• Adding and managing RSS feed links in a shared database
• Subscribing to various RSS feeds to personalize content
• Periodic fetching and aggregation of RSS feed posts to keep user content up-to-date

Built with

• Golang
• Postgres
• Redis
• Docker
• CobraCLI

Prerequisites

1. Golang 1.24+
2. Docker - For containerized services (PostgreSQL & Redis)
3. Git
4. Golang-Migrate
5. Swag Cli - For API testing

Infrastructure (Optional)

• kind
• kubectl
• terraform

Setup

1. Clone the repository and navigate into the project directory

git clone https://github.com/tonievictor/ogugu && cd ogugu

2. Install dependencies

go get ./..

3. Copy the .env.example file to .env and provide the necessary values for your local setup:

cp .env.example cmd/server/.env

4. Set up the database and cache (optional):

Note

If you don't already have a PostgreSQL and Redis instance, you can set them up by running the following command. This will spin up PostgreSQL and Redis containers and expose them on your machine

docker compose up -d

5. Run Database Migrations

export PGURL=<databaseurl>
migrate -database ${PGURL} -path migrations up

Kubernetes and Monitoring Setup (optional)

1. Setup a kubernetes cluster

Tip

For local development and testing, kind (Kubernetes IN Docker) is recommended. It provides a lightweight Kubernetes cluster running inside Docker containers on your machine.

kind create cluster

2. Provision infrastructure with Terraform

cd infra/monitoring
terraform init
terraform plan   
terraform apply

3. Verify Deployment

kubectl get pods -n monitoring

4. Expose monitoring dashboards to localhost

# forward grafana port
kubectl port-forward svc/grafana 3000:80 -n monitoring
# forward tempo port
kubectl port-forward svc/tempo 4318 -n monitoring

Usage

After completing the setup and deployment, follow these steps to run the application and interact with its API:

1. Generate Swagger Docs

swag init -g cmd/server/main.go

2. Run the application

cd cmd/server && go run main.go

3. Access the Swagger UI to test the API at http://localhost:<port>/v1/swagger/index.html

View monitoring dashboard (if set up):

• Navigate to: http://localhost:3000
• Login credentials can be found in terraform/values/grafana.yaml

CLI

Ogugu comes with a CLI tool that allows you to fetch RSS posts from all subscribed feeds. This is useful for running periodic updates via a cron job or other task scheduler.

1. Build the CLI binary

go build -o cli cmd/cli/main.go

2. Run the CLI

./cli cron --database "<database connection string>"

## replace <database connection string> with your actual PostgreSQL connection string.