Skip to content

runbiscuit/layered

Repository files navigation

Layered 2.0 (beta)

Complete rewrite of the Transmission Web Interface with Material Design, using jQuery, MaterializeCSS and Unsemantic CSS Framework.

Current version: v2.0-beta4 - added internationalization support

Screenshots

Desktop

Screenshot Desktop

Mobile Compatiblity?

Yes, this does not work right now, but you can use apps like Transdrone for Android - it works pretty well.

But, I don't have Transmission installed yet!

You can use the AtoMiC ToolKit, provided here, if you haven't gotten Transmission installed.

Installation

You can use Layered instead of the original web client to remotely administrate your transmission application.

Using Environment Variables

If you're just trying Layered out, it is recommended to set the TRANSMISSION_WEB_HOME environment variable to the root path of this web client. Then you just need to open the location to the transmission web server (e.g. localhost:9091) and it will work.

Manual Installation

Move the Layered files in the right location, and the next time you start Transmission, it will use Layered. If you're using the daemon, you can simply send it a SIGHUP.

Linux

To use Layered, you may replace the contents of /usr/share/transmission/web.

cd /usr/share/transmission
rm -rf /usr/share/transmission/web
git clone https://github.com/theroyalstudent/layered.git web

Mac OS X

To use Layered, you may replace the contents of /Applications/Transmission.app/Contents/Resources/web/.

cd /Applications/Transmission.app/Contents/Resources
rm -rf /Applications/Transmission.app/Contents/Resources/web
git clone https://github.com/theroyalstudent/layered.git web

Contributing

Feel free to make pull requests to the develop branch, and for any bugs, please do not hesitate to open an issue!

To install the dependencies used to build resources:

bower install
npm install

You would need bower and npmjs to be installed on your machine before you begin.

Building the code

To build the resources as you edit the code, you may run gulp launch, and terminate it with Ctrl-C (Mac) when you're done.

Contributing Internationalizations

To add a new internationalizations, duplicate the resources/js/i18n/en.js file to resources/js/i18n/[LANGUAGE].js, where LANGUAGE is the ISO 639-1 Code of the language. You may then edit the new language file accordingly.

Do note that if you have gulp launch already running, you need to restart it and save the file, otherwise the file would not picked up by the watch process.

// side note: the web interface will automatically pick up on which languages have a internationalizations available for it, thus there is nothing else to configure, when adding a new internationalizations file.

Pushing code back to the upstream

Before making your commit and pull request, run gulp build --production to build the minified resources.

Credits

Libraries Used:

Licenses

Copyright (C) 2014-2017 Edwin A. edwin@theroyalstudent.com

This work is licensed under the Creative Commons Attribution-ShareAlike 3.0

Unported License: http://creativecommons.org/licenses/by-sa/3.0/