arss

An rss reader that doesn't try to do too much

Demo

https://user-images.githubusercontent.com/40111357/116642642-59d28480-a93d-11eb-96d7-23bd97e7209e.mp4

Motivation

I wanted a very minimal RSS reader that wasn't feature packed, but could be extended. Something super simple.

Installation

Requirements:

• go >= 1.16
• node >= 16.0.0

macOS

Install via Homebrew

brew install 1ntEgr8/tap/arss-reader

From source

• Clone the repo

  git clone https://github.com/1ntEgr8/arss

• Run the install script. You will need to specify the directory in which you want the binary to be installed

  chmod +x ./install.sh
  ./install.sh --path path/to/installation/directory

Usage

Run arss. You should see the rss reader automatically open in your default browser.

arss comes with a default web client. However, you can also write your own. See Writing your own client for more information.

To tell arss to use your client instead of the default, use the client flag

arss --client /path/to/client

Developing

The client is written in Svelte. The server is in Go

• Run the client

  cd client && npm run dev

• Run the server

  go run arss --client client/public

You should see the client open up in the browser.

The client supports hot-reload, however, the server doesn't. You will have to rebuild the server each time you make a change. By default, the server auto-opens the page in your browser. If you do not want this, pass in the --headless flag.

By default, the server uses port 8080. You can change this with the --port flag.

Writing your own client

The arss server exposes a REST api that you can use to populate your client. Take a look at main.go for a list of routes.

Bugs/New features

Feel free to file an issue if you spot a bug or want to make a feature request

Contributing

PRs are welcome :) See Developing for details on how to set up a dev environment.