mirror of
https://github.com/VueTorrent/VueTorrent.git
synced 2024-11-25 19:05:51 +03:00
Update README.md
This commit is contained in:
parent
7be1e25a0e
commit
06fc4b9b44
1 changed files with 54 additions and 11 deletions
65
README.md
65
README.md
|
@ -1,15 +1,58 @@
|
||||||
# Vuetorrent
|
# VueTorrent
|
||||||
|
|
||||||
## Project setup
|
A modern looking WEBUI for qBittorrent made with Vuejs & express!
|
||||||
```
|
|
||||||
- development
|
|
||||||
|
|
||||||
npm install & npm run serve
|
(support for more clients coming in the future)
|
||||||
|
|
||||||
- production
|
## Screenshots
|
||||||
|
|
||||||
npm install & npm run build
|
<p align="center">
|
||||||
then copy dist to server/dist
|
<a href="https://i.imgur.com/vPBcrK4.png"><img src="https://i.imgur.com/vPBcrK4.png" title="Desktop" alt="Desktop Screenshot" ></a>
|
||||||
rename config.example.json to config.json
|
</p>
|
||||||
run node server/src/server.js
|
|
||||||
```
|
<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="500"></a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
> Vue, Node, Express, qBitorrent
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
- Probably a Docker image but I haven't properly figured out this part yet...
|
||||||
|
|
||||||
|
### Development
|
||||||
|
|
||||||
|
FRONTEND : Git clone & npm run serve!
|
||||||
|
|
||||||
|
SERVER : (npm run build, copy dist to server (optional)) & nodemon server.js!
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 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...)
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
I'll gladly accept help & advice! (this is my first project of this nature, pls be kind :P ).
|
||||||
|
|
||||||
|
## 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 :P
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
|
||||||
|
|
Loading…
Reference in a new issue