VueTorrent/README.md

59 lines
1.7 KiB
Markdown
Raw Normal View History

2019-04-17 22:14:33 +03:00
# VueTorrent
2019-04-15 17:50:38 +03:00
2019-04-17 22:14:33 +03:00
A modern looking WEBUI for qBittorrent made with Vuejs & express!
(support for more clients coming in the future)
2019-04-18 08:45:00 +03:00
> Vue, Node, Express, qBitorrent
2019-04-17 22:14:33 +03:00
## 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="500"></a>
</p>
2019-04-15 17:50:38 +03:00
2019-04-17 22:14:33 +03:00
## Installation
- Probably a Docker image but I haven't properly figured out this part yet...
2019-04-18 08:45:00 +03:00
## Development
2019-04-17 22:14:33 +03:00
FRONTEND : Git clone & npm run serve!
2019-04-18 08:45:00 +03:00
SERVER : (npm run build, copy dist to /server (optional)) & nodemon server.js!
2019-04-17 22:14:33 +03:00
## 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
2019-04-18 08:45:00 +03:00
I'll gladly accept help/pull requests & advice! (this is my first project of this nature, pls be kind 😛 ).
2019-04-17 22:14:33 +03:00
## 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>
2019-04-18 08:45:00 +03:00
- 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.
2019-04-17 22:14:33 +03:00
---
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)