gator – A Command-Line RSS Feed Aggregator Using PostgreSQL

This project is CLI built with GO to:

• Add RSS feeds from across the internet to be collected
• Store the collected posts in a PostgreSQL database
• Follow and unfollow RSS feeds that other users have added
• View summaries of the aggregated posts in the terminal, with a link to the full post

It was developed using goose for database migrations, psql as the terminal client, and sqlc to generate type-safe ORM functions.

Run the CLI

To run the CLI, it's necessary to have Go installed and a PostgreSQL database connection set up.

Create a ~/.gatorconfig.json file in your home directory with your PostgreSQL connection URL and a current_user_name field, which will be used by the CLI commands.

{
  "db_url": "postgres://postgres:postgres@localhost:5432/gator?sslmode=disable",
  "current_user_name": ""
}

Clone the repository locally and access the repo:

git clone https://github.com/lealre/gator.git

Install the CLI:

go install

Run the CLI:

gator register 'your_username'

Note

To run the commands without installing, use go run . <command>.

Commands

• login <name>: Set the current user in ~/.gatorconfig.json.
• register <name>: Create a new user and set it as the current user in ~/.gatorconfig.json.
• users: List all users.
• reset: Delete all records from the database.
• addfeed <name> <url>: Add a new RSS feed.
• feeds: List all feeds and the users who created them.
• follow <url>: Set the current user to follow a feed.
• unfollow <url>: Set the current user to unfollow a feed.
• following: List all feeds being followed by the current user.
• agg <interval>: Aggregate the feeds and store the posts in the database (e.g., gator agg 10s).
• browse <limit>: List all posts, up to the specified limit (default limit is 2).