Skip to content

alexrios/urss

Repository files navigation

urss

A minimalist RSS reader built on intentional design principles.

URSS Reader

In an age of algorithmic feeds and infinite doom-scrolling, the RSS reader is the last bastion of intentional consumption.

Philosophy

This project follows The Clarity Protocol - a design manifesto for modern RSS readers that prioritizes focus, usability, and respect for both content and users.

Read the full philosophy: DESIGN_GUIDELINES.md

Tech choices

  • Kotlin Multiplatform - Cross-platform shared logic
  • Compose Multiplatform - Modern declarative UI
  • Room - Local database with SQLite
  • Ktor - HTTP client for feed fetching
  • jsoup - HTML parsing and sanitization
  • Coroutines - Asynchronous operations

Status

Early development, but fully functional - v0.1.0

Currently supporting desktop with Android planned.

Getting started

Prerequisites

  • mise - Development environment manager
  • Gradle (included via wrapper)

Setup

Install dependencies using mise:

mise install

This will automatically install Java 17 and other required tools based on .mise.toml.

Build & Run

Run the desktop application:

mise exec -- ./gradlew :desktop:run

Or activate mise in your shell and run directly:

mise shell
./gradlew :desktop:run

Testing

Run the full build and test suite (same as CI):

mise exec -- ./gradlew build test

Project Structure

urssreader/
├── shared/          # Kotlin Multiplatform shared code
│   ├── domain/      # Business logic and entities
│   ├── data/        # Repositories and data sources
│   └── database/    # Room database definitions
└── desktop/         # Desktop UI application
    └── ui/          # Compose Desktop interfaces

Key Features (planned)

  • Thumb-first navigation for mobile.
  • Content-focused reading experience.
  • Gesture-driven interactions (mobile).
  • Aggressive offline caching.
  • Zero-anxiety "Mark All Read" functionality.

License

To be determined.

About

URSS (or Your RSS) is a multiplatform RSS reader. [Don't confuse with USSR]

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages