Gator

Gator is a guided RSS project from Boot.Dev. It allows users to manage RSS feeds, follow feeds, and browse posts using a command-line interface.

Prerequisites

To use gator, you need:

• PostgreSQL: Ensure you have a running PostgreSQL instance.
• Go: Install Go (version 1.24.1 or later).

Installation

To install Gator, run the following command in your terminal:

go install github.com/GLobyNew/gator@latest

Configuration

Gator requires a configuration file named .gatorconfig.json in your home directory. The file should include the following fields:

{
  "db_url": "your_postgres_connection_string",
  "current_user_name": "your_username"
}

Replace your_postgres_connection_string with your PostgreSQL connection string and your_username with your desired username.

Usage

Run Gator with the following commands:

User Management

• Register a new user:

  gator register <username>

• Login as an existing user:

  gator login <username>

• List all users:

  gator users

• Reset the database:

  gator reset

Feed Management

• Add a new feed:

  gator addfeed <feed_name> <feed_url>

• List all feeds:

  gator feeds

• Follow a feed:

  gator follow <feed_url>

• List followed feeds:

  gator following

• Unfollow a feed:

  gator unfollow <feed_url>

Browsing Posts

• Browse posts:

  gator browse [limit]

  The limit parameter is optional and defaults to 2.

Aggregation

• Start feed aggregation:

  gator agg <time_between_requests>

  Replace <time_between_requests> with a duration (e.g., 1m for 1 minute).

License

This project is licensed under the GNU General Public License v3.0.

Contributing

Don't contribute. It's guided project and I don't to expect to keep track of it.

Acknowledgments

This project is part of the Boot.Dev guided learning program.