Skip to content

katsuikeda/gator

Repository files navigation

gator

A multi-user command line tool for aggregating RSS feeds and viewing the posts.

Installation

Make sure you have the latest Go toolchain installed as well as a local PostgreSQL database. You can then install gator with:

go install github.com/katsuikeda/gator@latest

Configuration

Create a configuration file .gatorconfig.json in your home directory with the following structure:

{
    "db_url": "postgres://username:@localhost:5432/database?sslmode=disable"
}

Replace the values with your database connection string.

Usage

Run the gator command-line tool with the following commands:

  • Create a new user:
gator register <username>
  • Add and follow a new RSS feed:
gator addfeed <feed_url>
  • Start the aggregator:
gator agg 30s
  • View aggregated feed posts
gator browse [limit]

There are a few other commands you'll need as well:

  • gator login <name> - Log in as a user that already exists
  • gator users - List all users
  • gator feeds - List all feeds
  • gator follow <url> - Follow a feed that already exists in the database
  • gator unfollow <url> - Unfollow a feed that already exists in the database

About

An RSS feed aggreagator in Go.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages