subarr

(β˜… 118)

The coordination, measurement, and quality layer that subgen never had. A peer service for the *arr family that adds calibrated audio-language detection, provider success leaderboards, and (v1.1) an in-app Whisper tuning lab.

  • .dockerignore
  • .git-blame-ignore-revs
  • .gitattributes
  • .gitignore
  • .pre-commit-config.yaml
  • CHANGELOG.md
  • CLAUDE.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • dbg.sh
  • deploy-to-dev.sh
  • docker-entrypoint.sh
  • Dockerfile
  • LICENSE
  • package-lock.json
  • package.json
  • pyproject.toml
  • README.md
  • RELEASING.md
  • SECURITY.md
  • verify.sh
  • vitest.config.mjs

# Installation Guide

1. Get the code
git clone https://github.com/coaxk/subarr

Downloads the entire project code from GitHub to your computer.

cd subarr

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up -d

Builds and starts all defined containers (server, database, etc.) at once, in the background.

docker compose pull

Runs the command against the services defined in the compose file.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install && npm run build:frontend # SPA bundles

Downloads and installs the libraries listed in package.json.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
python -m venv .venv && source .venv/bin/activate

Runs the Python script (or module).

pip install -e .[dev]

Installs the Python libraries listed in requirements.txt (or similar).

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation