/Readarr

Readarr is a fork of Sonarr for ebooks and possibly magazines and comics in the future. Development only just started so make sure to keep track of this repo for updates.

Primary LanguageC#GNU General Public License v3.0GPL-3.0

Readarr

Readarr is a PVR for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new ebooks and will grab, sort and rename them.

Major Features Include:

  • Support for major platforms: Windows, Linux, macOS, Raspberry Pi, etc.
  • Automatically detects new ebooks
  • Automatic failed download handling will try another release if one fails
  • Manual search so you can pick any release or to see why a release was not downloaded automatically
  • Fully configurable episode renaming
  • Full integration with SABnzbd and NZBGet
  • Full integration with your favourite ebook management software (tbd)
  • And a beautiful UI

Configuring Development Environment:

Requirements

Setup

  • Make sure all the required software mentioned above are installed
  • Clone the repository into your development machine. info
  • Grab the submodules git submodule init && git submodule update
  • Install the required Node Packages yarn -g

Backend Development

  • Run yarn build to build the UI
  • Open Sonarr.sln in Visual Studio
  • Make sure NzbDrone.Console is set as the startup project
  • Build NzbDrone.Windows and NzbDrone.Mono projects
  • Build Solution

UI Development

  • Run yarn watch to build UI and rebuild automatically when changes are detected
  • Run Sonarr.Console.exe (or debug in Visual Studio)

License