Work

miniflux-sanity

A screenshot from my Terminal showcasing the utility in action.

Role

Author

Duration

A couple of days

Source Code

git repository

Stargazers on GitHub ⭐

Tools Used/Explored

  • Ruby

Motivation

If I haven't read something in the preceding month, it's unlikely I ever will. Miniflux doesn't offer an archive option so we mark entries as read instead. All it really does is offer me a saner overview of "unread" items at the top.

As is usually the case for me, I wanted to build something meaningful as I pick up Ruby again. This was a small use-case that was a good first challenge to tackle.

The code is admittedly not perfect. I welcome any constructive criticism or feedback, more so if you are a Ruby enthusiast.

Feature-set

  • Uses token authentication
  • Supports cloud and self-hosted Miniflux apps
  • Configurable number of days before which to mark items as read
  • Resumes marking as read if interrupted

Goals

  • Get comfortable with Ruby's syntax
  • Work with Class, Module, dotenv etc.
  • Work with JSON
  • Work with Ruby's File API
  • Interact with an API using an HTTP library