mirror of https://github.com/Sonarr/Sonarr.git synced 2024-12-14 11:23:42 +02:00

Smart PVR for newsgroup and bittorrent users.

Go to file

Mark McDowall c90672a5ab More renaming tokens New: Always show Air Date renaming token in help modal Fixed: Added missing media info renaming tokens		2019-04-12 17:48:45 -07:00
.github	Update bug issue template	2018-05-21 12:43:07 -07:00
distribution	Fixed typo in postinst preventing it from properly upgrading v3 alpha installs.	2019-01-02 22:06:58 +01:00
frontend	More renaming tokens	2019-04-12 17:48:45 -07:00
Logo	Update Logos	2018-12-29 13:08:46 +01:00
macOS	v3 Binaries	2018-12-29 13:08:47 +01:00
schemas	add downloadvolumefactor and uploadvolumefactor torznab attributes (#1464 )	2016-09-23 21:08:50 +02:00
setup	Fixed: Default Windows Service Account	2018-12-29 13:08:47 +01:00
src	Fixed: Improve exception logging when unable to connect to Plex Media Server	2019-04-12 17:46:47 -07:00
tools	MSBuild 15	2018-12-29 13:08:50 +01:00
.editorconfig	Linting error.	2019-03-09 00:21:06 +01:00
.esprintrc	v3 UI	2018-12-29 13:08:43 +01:00
.gitattributes	Added git attributes file to force LF endings	2013-10-11 15:53:27 -07:00
.gitignore	Removed old UI	2018-12-29 13:08:45 +01:00
.gitmodules	New: Fallback to libcurl/libssl on mono for https connections.	2015-06-27 01:44:23 +02:00
.yarnrc	Downgrade event-stream	2019-02-22 16:27:47 -08:00
build.sh	Fixed wrong sed wildcard.	2018-12-29 13:49:42 +01:00
CLA.md	Cleaned up project root.	2015-08-02 22:22:22 -07:00
CONTRIBUTING.md	Update docs	2019-04-09 20:47:50 -07:00
COPYRIGHT.md	Added License and Copyright file for completeness.	2017-07-27 22:04:57 +02:00
gulpFile.js	Removed old UI	2018-12-29 13:08:45 +01:00
LICENSE.md	Added License and Copyright file for completeness.	2017-07-27 22:04:57 +02:00
package.json	Eliminate gulp-flatten	2019-03-23 11:56:16 -07:00
README.md	Update docs	2019-04-09 20:47:50 -07:00
test.sh	Set test log output via environment variable	2017-09-17 16:58:14 -07:00
version.sh	Replace Major.Minor.Revision in the TC provided BuildNumber with the packageVersion.	2018-12-29 13:49:42 +01:00
yarn.lock	Eliminate gulp-flatten	2019-03-23 11:56:16 -07:00

README.md

Sonarr

Sonarr is a PVR for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new episodes of your favorite shows and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.

Major Features Include:

Support for major platforms: Windows, Linux, macOS, Raspberry Pi, etc.
Automatically detects new episodes
Can scan your existing library and download any missing episodes
Can watch for better quality of the episodes you already have and do an automatic upgrade. eg. from DVD to Blu-Ray
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 Kodi, Plex (notification, library update, metadata)
Full support for specials and multi-episode releases
And a beautiful UI

Configuring Development Environment:

Requirements

[Visual Studio 2017] (https://www.visualstudio.com/vs/)
Git
NodeJS
Yarn

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

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

GNU GPL v3