VueTorrent/README.md

88 lines
2.2 KiB
Markdown
Raw Normal View History

2020-05-22 11:36:51 +03:00
# VueTorrent [under construction]
The sleekest looking WEBUI for qBittorrent made with Vuejs!
> Vue, qBitorrent, Vuetify
## Screenshots
<p align="center">
<a href="https://imgur.com/xgwECT2.png"><img src="https://imgur.com/xgwECT2.png" title="Desktop" alt="Desktop Screenshot" ></a>
</p>
<p align="center">
<a href="https://i.imgur.com/SUOEyy9.png"><img src="https://i.imgur.com/SUOEyy9.png" title="Mobile" alt="Mobile Screenshot" width="320" height="540"></a>
</p>
## Installation
2020-05-22 14:19:28 +03:00
- Visit the releases page!
2020-05-22 14:19:28 +03:00
- Download the latest STABLE release.zip
- Unzip this folder
- Point your Alternate WEBUI location to the 'vuetorrent' folder
## Development
- clone the repo
* npm install
- npm run serve
## Features
- viewing sessions status ( down / upload speed, session uploaded / downloaded )
- adding / removing / pausing / resuming torrents
* sorting by every property shown!
- mobile friendly! (maybe not for thousands of torrents...)
2020-05-26 22:32:33 +03:00
- torrent info / trackers / peers / content
2020-07-21 10:45:31 +03:00
- searching for new torrents straight from the WEBUI!
- changing the most common settings
* works on QBittorrent V4.2 and later
2020-05-26 10:07:09 +03:00
### Sorting/Filtring
example queries:
- s name asc => sort by name ascending
- sort size desc => sort by size descending
- f ubuntu => filter by torrent-name that contains 'ubuntu'
2020-05-26 22:32:33 +03:00
- filter done => filter all completed torrents
- filt busy => filter all downloading torrents
2020-05-26 10:07:09 +03:00
## Contributing
I'll gladly accept help/pull requests & advice! (this is my first project of this nature, pls be kind 😛 ).
## FAQ
- **Why build this??**
* Why not? Most WebUI's look very dated and now it's no longer necessary to search for a remote control app!
## Support
Reach out to me at one of the following places!
- <a href="https://m.me/WijnsDaan" target="_blank">`Facebook Messenger`</a>
* Open up an issue 😛
[<img src="https://cdn.buymeacoffee.com/buttons/lato-blue.png" alt="drawing" width="180"/>](https://www.buymeacoffee.com/wdaan 'Buy me a coffee')
## Credits
- Dashboard design heavily inspired by: '[Net Ninja - Vuetify](https://github.com/iamshaunjp/vuetify-playlist)'.
2020-05-22 11:36:51 +03:00
* This repo '[CzBiX qb-web ](https://github.com/CzBiX/qb-web)'