gator

Gator is an RSS feed aggregator in Go.

Requirements

You need Go and PostgreSQL installed to run this application.

Installation

go install github.com/angelofallars/gator@latest

Config

To set up the config file, create a ~/.gatorconfig.json file in the home directory with the following content:

{
  "db_url": "postgres://<USERNAME>:<PASSWORD>@localhost:5432/database?sslmode=disable"
}

Replace the value in db_url with the appropriate username and password for your PostgreSQL database.

Commands

register

Arguments: user (string)

Register as the user, and log in as that user.

login

Arguments: user (string)

Log in as the user.

users

Arguments: N/A

List out all the users in the application.

addfeed

Arguments: name (string), url (string)

Add an RSS feed and follow that feed.

agg

Arguments: time_interval (duration)

Fetch posts from the saved feeds added by addfeed every time_interval.

Example time_interval arguments: 3s, 1m, 30m, 1h.

feeds

Arguments: N/A

List out all the feeds by all users.

follow

Arguments: url (string)

Follow the feed with the given url.

following

Arguments: N/A

List out the currently-followed feeds by the logged-in user.

unfollow

Arguments: url (string)

Unnfollow the feed with the given url.

browse

Arguments: limit (int, optional)

Browse the latest posts from the user's subscribed feeds, up to the limit, default 2 posts.

reset (DANGER!)

Arguments: N/A

Resets the entire database.