mirror of
https://github.com/VueTorrent/VueTorrent.git
synced 2024-11-24 18:36:14 +03:00
131 lines
5.5 KiB
Markdown
131 lines
5.5 KiB
Markdown
<div>
|
|
<img style="float: left" width="200" src="https://cdn.jsdelivr.net/gh/WDaan/VueTorrent/VueTorrent-logo.png" alt="VueTorrent"/>
|
|
<h1>VueTorrent</h1>
|
|
<p>The sleekest looking WebUI for qBittorrent made with Vue.js!</p>
|
|
|
|
Join us on [Discord](https://discord.gg/KDQP7fR467)
|
|
</div>
|
|
|
|
 
|
|
|
|
|
|
 
|
|
 
|
|
 
|
|
 
|
|
|
|
## Screenshots
|
|
|
|
- Desktop
|
|
<p>
|
|
<img src="readme_assets/screenshot-desktop.png" width="800" alt="Screenshot Desktop (Light Mode)" />
|
|
</p>
|
|
|
|
- Desktop Dark Mode
|
|
<p>
|
|
<img src="readme_assets/screenshot-desktop-dark-mode.png" width="800" alt="Screenshot Desktop (Dark Mode)" />
|
|
</p>
|
|
|
|
- Mobile Dark Mode
|
|
<p>
|
|
<img src="readme_assets/screenshot-mobile-dark-mode.png" width="400" alt="Screenshot Mobile Dashboard (Dark Mode)" />
|
|
<img src="readme_assets/screenshot-mobile-navbar-dark-mode.png" width="400" alt="Screenshot Mobile Dashboard (Light Mode)" />
|
|
</p>
|
|
|
|
## Installation
|
|
|
|
### Manual
|
|
|
|
- Visit the [Releases](https://github.com/WDaan/VueTorrent/releases) page!
|
|
- Download the latest `vuetorrent.zip`
|
|
- Unzip the downloaded file
|
|
- Point your alternate WebUI location to the `vuetorrent` folder in qBittorrent settings
|
|
|
|
### From Source
|
|
|
|
- Clone branch using
|
|
- `git clone --single-branch --branch latest-release https://github.com/WDaan/VueTorrent.git`
|
|
- Pull changes every once in a while, using `git pull`
|
|
|
|
If you like to always have the latest and greatest, please sync to the `nightly-release`-branch. This can contain breaking changes though.
|
|
|
|
### Lazy/Easy
|
|
|
|
- use [hotio's qbittorrent](https://hotio.dev/containers/qbittorrent/) docker image, that comes pre-packed with VueTorrent.
|
|
|
|
[Alternative methods - May work for older QBit versions](../../wiki/Alternative_Installation_Methods)
|
|
|
|
## Development
|
|
|
|
- Clone the repo
|
|
- `npm install`
|
|
- `npm start`
|
|
- `npm run lint` (to format the code)
|
|
- `docker-compose up -d` (starts a qbittorrent docker, optional)
|
|
- Open the WebUI on localhost with the default username `admin` and password `adminadmin`.
|
|
- Make sure CSRF protection is disabled on the target server!
|
|
- Edit `env.development` to tweak your dev environment (e.g. fake torrents)
|
|
|
|
## Features
|
|
|
|
- Torrents
|
|
- add / remove / pause / resume / rename torrents
|
|
- selectively download files
|
|
- view info / trackers / peers / content / tags & categories
|
|
- search for new torrents straight from the WebUI!
|
|
- search filtering powered by Fuse.js!
|
|
- Keyboard shortcuts!
|
|
- Mac keymap is supported (use <kbd>Cmd</kbd> instead of <kbd>Ctrl</kbd>)
|
|
- Press <kbd>Escape</kbd> to dismiss any dialogs or to return to Dashboard view
|
|
- Dashboard
|
|
- Select all torrents with <kbd>Ctrl</kbd>-<kbd>A</kbd>
|
|
- Focus search input with <kbd>Ctrl</kbd>-<kbd>F</kbd>
|
|
- Press again to enable native browser search
|
|
- When no dialogs are opened, press <kbd>Escape</kbd> to unfocus search input
|
|
- Press again to unselect all torrents
|
|
- Delete selected torrents with <kbd>Delete</kbd> (<kbd>Fn</kbd>-<kbd>Backspace</kbd> on Mac)
|
|
- <kbd>Ctrl</kbd>-click on a torrent card to enable multi-select mode and select it
|
|
- Hold <kbd>Shift</kbd> and click on a torrent card to select all torrents between the last selected torrent and the clicked torrent
|
|
- System
|
|
- see session stats (down / upload speed, session uploaded / downloaded, free space)
|
|
- beautiful transfer graphs
|
|
- change the most common settings
|
|
- Extra features the default WebUI doesn't have
|
|
- mobile friendly! (can be installed as a PWA)
|
|
- Configureable Dashboard: choose which torrent properties are shown for both busy and completed torrents
|
|
- works with qBittorrent v4.4 and later
|
|
|
|
## Contributing
|
|
|
|
I'll gladly accept help/pull requests & advice!
|
|
|
|
[FAQ](../../wiki/FAQ)
|
|
|
|
### Localize the app
|
|
|
|
To help us localize VueTorrent, you will need to:
|
|
- `src/locales/<your language>.json`
|
|
- Create a json file containing the translations by matching the structure of `en.json`
|
|
- every key may not be specified, that's fine, it will default to the english locale
|
|
- `<your language>` should match the ISO 639 locale code of the added language
|
|
- `src/locales/locales.ts`
|
|
- add your language to the `Locales` enum, it should match the json filename
|
|
- Update the `LOCALES` constant with the local language name and the created enum value
|
|
- `src/locales/index.ts`
|
|
- import the json file
|
|
- include it in the `messages` object using the created enum value as key
|
|
|
|
## Support
|
|
|
|
Open up an issue 😛
|
|
|
|
but before you do that:
|
|
|
|
- confirm you're on the latest version of VueTorrent
|
|
- confirm there is no other issue mentioning the same problem
|
|
|
|
<a href="https://www.buymeacoffee.com/wdaan"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=wdaan&button_colour=FFDD00&font_colour=000000&font_family=Arial&outline_colour=000000&coffee_colour=ffffff"></a>
|
|
|
|
## Contributors
|
|
- [@m4ximuel](https://github.com/m4ximuel)
|
|
- [@Larsluph](https://github.com/Larsluph)
|