Update README.md

This commit is contained in:
Daan Wijns 2019-04-17 21:14:33 +02:00 committed by GitHub
parent 7be1e25a0e
commit 06fc4b9b44
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,15 +1,58 @@
# Vuetorrent
# VueTorrent
## Project setup
```
- development
A modern looking WEBUI for qBittorrent made with Vuejs & express!
npm install & npm run serve
(support for more clients coming in the future)
- production
## Screenshots
npm install & npm run build
then copy dist to server/dist
rename config.example.json to config.json
run node server/src/server.js
```
<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="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)