goread

👋 Hello! This is an RSS reader which allows you to browse the web better! It's accompanied by a beautiful TUI made with bubble tea

❤️ Getting started

Getting it up and running is pretty easy! This is how you do it.

1. Clone the repository

git clone --depth=1 https://github.com/TypicalAM/goread && cd goread

2. Build the executable

On Linux

go build -o goread cmd/goread/main.go

On Windows

go build -o goread.exe cmd/goread/main.go

3. Run the program!

./goread --help

📸 Here is a demo of what it looks like:

Here is some basic usage:

Here we use pywal to generate a colorscheme from an image and then convert it to a goread colorscheme!

⚙️ Configuration

📝 The urls file

The urls file contains the categories and feeds that you are subscribed to! This file is generated by the program at the ~/.config/goread/urls.yml location and looks something like that:

categories:
    - name: News
      desc: News from around the world
      subscriptions:
        - name: BBC
          desc: News from the BBC
          url: http://feeds.bbci.co.uk/news/rss.xml
    - name: Tech
      desc: Tech news
      subscriptions:
        - name: Wired
          desc: News from the wired team
          url: https://www.wired.com/feed/rss
        - name: Chris Titus Tech (virtualization)
          desc: Chris Titus Tech on virtualization
          url: https://christitus.com/categories/virtualization/index.xml

You can edit this file yourself or create a script which can for example automatically add a feed from your clipboard!

🌃 The colorscheme file

The colorscheme file contains the colorscheme of your application it can be generated by hand or using the --get_colors flag which the pywal colors.json. An Example file would look something like this!

{
    "BgDark": "#040612",
    "BgDarker": "#040612",
    "Text": "#98ccdc",
    "TextDark": "#98ccdc",
    "Color1": "#625160",
    "Color2": "#BD4354",
    "Color3": "#985063",
    "Color4": "#BA9C6A",
    "Color5": "#1E5AA6",
    "Color6": "#C25C9F",
    "Color7": "#98ccdc"
}

✨ Tasks to do

Here are the things that I've not yet implemented, contributions and suggestions are very welcome!

• A main category where all the feeds are aggregated
• Moving the help to the bubbletea help bubble

💁 Credit where credit is due

Libraries

The demo was made using vhs, which is an amazing tool, and you should definitely check it out. The entirety of charm.sh libraries was essential to the development of this project. The cobra library helped to make the cli flags and settings.

Fonts & logo

The font in use for the logo is sen-regular designed by "Philatype" and licensed under Open Font License. The icon was designed by throwaway icons.