Gator 🐊

gator ? My favorite blog aggregator

Requirements

In order to make gator work you need:

• postgresql
• go

Installation

To install on an unix system just type

go install github.com/macrespo42/Gator@latest

Configuration

You'll need to have a .gatorconfig.json in your $HOME directory location like

.gatorconfig.json

Example of a valid config file:

{
    "db_url":"postgres://macrespo:@localhost:5432/gator?sslmode=disable", // mandatory
    "current_user_name":"kahya" // optionnal, be set with the cli
}

Commands

You can run a command with

Gator command_name arg1 arg2...

There is a list of all availables commands:

• register $name_of_user | register a new user
• login $name_of_user | log a registered user
• reset | ⚠️ DEV command, reset database
• users | Get a list of registered users
• agg $10s | Scrape feeds from rss flux at the interval given as argument
• feeds | Get a list of added feeds
• addfeed $title $url | add a feed to the database
• follow $feed_title | follow feed by title
• unfollow $feed_title | unfollow feed by title
• following | list of your following feeds
• browse $limit=2 | browse feeds from your following list

Improvement tips

• Add sorting and filtering options to the browse command
• Add pagination to the browse command
• Add concurrency to the agg command so that it can fetch more frequently
• Add a search command that allows for fuzzy searching of posts
• Add bookmarking or liking posts
• Add a TUI that allows you to select a post in the terminal and view it in a more readable format (either in the terminal or open in a browser)
• Add an HTTP API (and authentication/authorization) that allows other users to interact with the service remotely
• Write a service manager that keeps the agg command running in the background and restarts it if it crashes