https://github.com/lealre/gator
A Command-Line RSS Feed Aggregator Using PostgreSQL
https://github.com/lealre/gator
cli go golang goose postgresql sqlc
Last synced: 8 months ago
JSON representation
A Command-Line RSS Feed Aggregator Using PostgreSQL
- Host: GitHub
- URL: https://github.com/lealre/gator
- Owner: lealre
- Created: 2025-03-31T20:01:31.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-04-12T19:24:46.000Z (9 months ago)
- Last Synced: 2025-05-08T23:56:38.590Z (8 months ago)
- Topics: cli, go, golang, goose, postgresql, sqlc
- Language: Go
- Homepage:
- Size: 39.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://github.com/pressly/goose) for database migrations, `psql` as the terminal client, and [sqlc](https://sqlc.dev/) to generate type-safe ORM functions.
## Run the CLI
To run the CLI, it's necessary to have [Go](https://go.dev/) 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.
```json
{
"db_url": "postgres://postgres:postgres@localhost:5432/gator?sslmode=disable",
"current_user_name": ""
}
```
Clone the repository locally and access the repo:
```shell
git clone https://github.com/lealre/gator.git
```
Install the CLI:
```shell
go install
```
Run the CLI:
```shell
gator register 'your_username'
```
> [!NOTE]
> To run the commands without installing, use `go run . `.
## Commands
- `login `: Set the current user in `~/.gatorconfig.json`.
- `register `: 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 `: Add a new RSS feed.
- `feeds`: List all feeds and the users who created them.
- `follow `: Set the current user to follow a feed.
- `unfollow `: Set the current user to unfollow a feed.
- `following`: List all feeds being followed by the current user.
- `agg `: Aggregate the feeds and store the posts in the database (e.g., `gator agg 10s`).
- `browse `: List all posts, up to the specified limit (default `limit` is 2).