mirrors/VueTorrent
1
0
Fork 0
mirror of https://github.com/VueTorrent/VueTorrent.git synced 2024-11-28 21:18:54 +03:00
Code Issues Projects Releases Packages Wiki Activity

readme

Browse source
This commit is contained in:
Daan Wijns 2020-05-11 18:21:24 +02:00
parent e99239d770
commit 402bb61a98
1 changed files with 219 additions and 218 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

437
README.md
View file

@ -1,219 +1,220 @@
# VueTorrent
A modern looking WEBUI for qBittorrent made with Vuejs & express!
(support for more clients coming in the future)
> Vue, Node, Express, qBitorrent
PS : This is NOT an alternate WEBUI, this is a webapp that interacts with your existing qBitorrent client.
## Update
now using this 'https://github.com/TheFlow95/node-qbittorrent-api-v2' qbittorrent-api
& deleting & adding don't quite work yet :/
## Screenshots
<p align="center">
<a href="https://i.imgur.com/vPBcrK4.png"><img src="https://i.imgur.com/vPBcrK4.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
Easiest way is with docker-compose:
```
vuetorrent:
image: wdaan/vuetorrent
container_name: vuetorrent
restart: always
ports:
- "4000:3000"
environment:
- VUE_APP_WEB_USER=vuetr
- VUE_APP_WEB_PASS=vuetr
- QBIT_USER=qbit
- QBIT_PASS=qbit
- QBIT_HOST=https://qbit.example.com
```
With Docker run
```
docker run --name=vuetorrent -d --env VUE_APP_WEB_USER=vuetr --env VUE_APP_WEB_PASS=vuetr --env QBIT_USER=admin --env QBIT_PASS=adminadmin --env QBIT_HOST=http://10.0.0.10:8080 --restart unless-stopped -p 3000:3000 wdaan/vuetorrent:latest
```
## Development
FRONTEND : Git clone & npm run serve!
SERVER : npm run build & npm run start!
## Features
- viewing sessions stats ( down / upload speed, session uploaded / downloaded )
- adding / removing / pausing / resuming torrents
- sorting by every property shown!
- mobile friendly! (maybe not for thousands of torrents...)
- works on QBittorrent V4.2 and later
## 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 😛
## Credits
Dashboard design heavily inspired by: 'https://github.com/iamshaunjp/vuetify-playlist'
Also check out The Net Ninja's Youtube Channel.
---
# VueTorrent
A modern looking WEBUI for qBittorrent made with Vuejs & express!
(support for more clients coming in the future)
> Vue, Node, Express, qBitorrent
PS : This is NOT an alternate WEBUI, this is a webapp that interacts with your existing qBitorrent client.
## Update
now using this 'https://github.com/TheFlow95/node-qbittorrent-api-v2' qbittorrent-api
& deleting & adding don't quite work yet :/
### With the updates it has become too unstable to use unfortunately, I'll update it when I find a fully working library or maybe write one myself if I find the time.
## Screenshots
<p align="center">
<a href="https://i.imgur.com/vPBcrK4.png"><img src="https://i.imgur.com/vPBcrK4.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
Easiest way is with docker-compose:
```
vuetorrent:
image: wdaan/vuetorrent
container_name: vuetorrent
restart: always
ports:
- "4000:3000"
environment:
- VUE_APP_WEB_USER=vuetr
- VUE_APP_WEB_PASS=vuetr
- QBIT_USER=qbit
- QBIT_PASS=qbit
- QBIT_HOST=https://qbit.example.com
```
With Docker run
```
docker run --name=vuetorrent -d --env VUE_APP_WEB_USER=vuetr --env VUE_APP_WEB_PASS=vuetr --env QBIT_USER=admin --env QBIT_PASS=adminadmin --env QBIT_HOST=http://10.0.0.10:8080 --restart unless-stopped -p 3000:3000 wdaan/vuetorrent:latest
```
## Development
FRONTEND : Git clone & npm run serve!
SERVER : npm run build & npm run start!
## Features
- viewing sessions stats ( down / upload speed, session uploaded / downloaded )
- adding / removing / pausing / resuming torrents
- sorting by every property shown!
- mobile friendly! (maybe not for thousands of torrents...)
- works on QBittorrent V4.2 and later
## 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 😛
## Credits
Dashboard design heavily inspired by: 'https://github.com/iamshaunjp/vuetify-playlist'
Also check out The Net Ninja's Youtube Channel.
---
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)