Skip to content

GeneKong/qbit-matUI

 
 

Repository files navigation

qBit MatUI
Qbit Material WebUI Build

Home Page

A material-themed UI for qBittorrent. This interface is more slimmed down, although still contains several features such as:

  • Bulk edit (pause, resume, delete, prioritize, and more)
  • Sorting by different metrics (name, size, date completed, etc.)
  • See torrent contents before downloading
  • File system navigation (choose where to save a torrent, create sub-folders, etc.)
  • Manage local & qBittorrent preferences
  • A fully material-themed UI (Light & Dark themes)
  • ... and more!

Demo!

A live demo is available here: https://qbit-material-webui-demo.herokuapp.com/.

Installation

This app is tested with v4.1.5 and higher of qBittorrent, any lower version are not guaranteed to work.

  1. Take a production-ready build from releases, or build it yourself
  2. Extract the files into any folder
  3. In qBittorrent, under Tools > Options > Web UI > Use alternative Web UI, set the file location as the folder you created in Step 2.
  4. Done!

Development

This app relies on a couple files to work properly.

General Config

Under src/assets/ there are two files: config.json and config.prod.json. This will store general configuration, such as the delimeter used when parsing file paths (Unix vs. Windows).

HTTP Config

If you wish to configure your endpoints and other data for dev/prod, do so here.

Running the App

To install the dependencies, run npm install in both the root directory and the mock_backend/ folder.

Back-end

  1. Navigate to mock_backend directory
  2. Run node index.js

Front-end:

  1. Run ng serve for a dev server
  2. Navigate to http://localhost:4200/
  3. Username: admin; Password: password; This can be changed under mock_backend/config.json

To run the login page standalone, do: ng serve login and navigate to http://localhost:4200/.

The app will automatically reload if you make changes to any of the Angular source code.

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

To get a build for the login page, run ng build --project="login", and provide the --prod flag for a production build.

About

A material WebUI for qBittorrent, written in Angular.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 63.1%
  • HTML 20.9%
  • SCSS 8.5%
  • JavaScript 6.3%
  • Other 1.2%