yarr

module
v0.0.0-...-e21216f Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 1, 2023 License: MIT

README

yarr

yarr (yet another rss reader) is a web-based feed aggregator which can be used both as a desktop application and a personal self-hosted server.

It is written in Go with the frontend in Vue.js. The storage is backed by SQLite.

screenshot

Features

  • Everything that original yarr had
  • Save items directly to your pocket with single click
  • Better display of nitter feed

Installation

The latest prebuilt binaries for Linux/MacOS/Windows are available here.

  • macos

    ⚠️ I don't use macos and has never tested any of changes on it so its possible things might break there

    • Download yarr-*-macos64.zip, unzip it, place yarr.app in /Applications folder, open the app
  • windows

    • Download yarr-*-windows64.zip, unzip it, open yarr.exe
  • linux

    • Download yarr-*-linux64.zip, unzip it, place yarr in $HOME/.local/bin
    • Run the script.
  • For self-hosting, see yarr -h for auth, tls & server configuration flags.

  • For building from source code, see build.md

  • For building with docker, see (docker.md)(doc/docker.md)

Enable Pocket Support

If you'd like to use the Add to Pocket button on the feeds then you can do so by following the steps mentioned below:

Manual Method

If the you don't wanna run the script you can also get the access_token manually. For that please follow the steps mentioned here

Why maintain a fork when project is active?

The original repository can be found here - https://github.com/nkanaev/yarr

I really loved using this RSS reader because this was simple to run and had all the functionality I was looking for in an RSS reader, except one. That was to share/add the item to your [pocket](https://getpocket.com/ account). And the original author didn't want to introduce any 3rd party dependencies in their version of the application. So I decided to fork it and add that(and maybe a few more) feature to my own fork.

Credits

  • Feather for icons.
  • The Docker configuration is taken from @Wakeful-Cloud (their fork)

Directories

Path Synopsis
src
parser
Atom 1.0 parser
Atom 1.0 parser
systray
Package systray is a cross-platform Go library to place an icon and menu in the notification area.
Package systray is a cross-platform Go library to place an icon and menu in the notification area.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL