empty

README

Empty Reader

Empty Reader is a minimalist application based on the zero inbox principle. It provides a simple and efficient way to manage your timeline by "clearing" seen items. With Empty Reader, you can read and delete items in a streamlined manner, following the minimal feature set philosophy.

Key Features:

• Follow RSS feeds to stay up-to-date with your favorite websites.
• Follow your Mastodon feed.
• Choose between a combined timeline or split view, depending on your preferences.
• Utilizes WebAssembly (WASM) for the frontend, completely written in Go
• Single binary install for easy deployment.

Currently missing: the general fediverse, some mastodon specials, custom folders with mixed feed sources, generic API endpoint for posting items from own scripts and tests.

Screenshots

Install

go install -v codeberg.org/mborho/empty/cmd/empty-reader@latest

On Linux, you can install a binary from the releases page. See there for builds for your specific platform (amd64, arch64).

There's also a Docker image available, see Docker for more details.

Usage

Most simple way to start empty-reader after install, just acting as an RSS feedreader:

EMPTY_USERNAME=yourname EMPTY_PASSWORD=yourpwd empty-reader

See Configuration for more possible ENV vars.

Build

make build

Development

To compile the client template files wasm/*.qtpl after changes, you have to install the qtc tool.
Regenerate the compiled template files wasm/*.qtpl.go with following command:

make build-template

Compile all and run for developement:

make dev-run

Configuration

The default parameters can be changed via the following environment vars:

EMPTY_DB_FILE=./empty.db
EMPTY_ADDR=localhost:8080
EMPTY_USERNAME=username
EMPTY_PASSWORD=password
EMPTY_DEBUG=false

You can follow your Mastodon timeline, if you create an own app on your mastodon instance.
See Obtaining client app access for more details.

EMPTY_TOOT_USERNAME=yourusername
EMPTY_TOOT_PASSWORD=pwd
EMPTY_TOOT_HOMESERVER=https://mastodon.example
EMPTY_TOOT_CLIENTID=01234567890123456789
EMPTY_TOOT_CLIENTSECRET=ABCDEF0123456789-9876543210FEDCBA

Depreacted You can follow your Twitter timeline, if you create an own app.
Create your own Twitter app for obtaining the neccessary keys and tokens.

EMPTY_TW_API_KEY=abcdefgh0123456789
EMPTY_TW_API_KEY_SECRET=abcdefgh0123456789abcdefgh0123456789
EMPTY_TW_ACCESS_TOKEN=1234567-ASBCDEF
EMPTY_TW_ACCESS_TOKEN_SECRET=1234567-ASBCDEF1234567-ASBCDEF

Docker

You can save the needed environment vars for configuration in an environment file .env and start docker with an argument for it:

docker run --rm -d --name="empty-reader" --env-file=.env -v $PWD:/data -p 8080:8080 codeberg.org/mborho/empty

License

Copyright 2023 Martin Borho

Apache License, Version 2.0 - see LICENSE for details.