Streamus

The most popular Chrome extension YouTube music player.

Overview

This is the repository for Streamus the browser extension. The source for Streamus' server and website are located in their own, respective repositories.

Streamus is currently supported on all derivatives of WebKit such as Chrome, Opera, Slimjet, and Iron. Additionally, it will support Edge once stable.

It can be installed through the Chrome Web Store, the Opera Web Store, or from the Streamus website

Development

Start by cloning the development branch. All PRs should be submitted to the development branch.

Dependencies

You will need to have [Node](https://nodejs.org/) installed on your system as well as [Grunt](http://gruntjs.com/). After installing Node, navigate using a terminal to the directory in which you cloned Streamus. Then, perform the following command to install dependencies:

npm install

Loading the extension

1. Navigate to **chrome://extensions/** 2. Ensure the checkbox labeled **Developer mode** is enabled. 3. Click the button labeled **Load unpacked extension...** 4. Select the directory **/StreamusChromeExtension/src/**

Editing LESS

Streamus' CSS is compiled via [LESS](http://lesscss.org/). As such, you need to run the following command from the '/StreamusChromeExtension' directory before modifying any LESS files:

grunt watch

After this command is running all modifications to .less files will automatically be compiled into .css.

API keys

You will need to modify the example key files located in the [/js/background/key/](https://github.com/MeoMix/StreamusChromeExtension/tree/Development/src/js/background/key) directory. Production keys are not committed to GitHub. There is an example key provided. It should not be relied upon for anything other than testing.

Server settings

Ensure that the property 'localDebug' is set to **false** unless you have configured an instance of Streamus' server on your local machine. The localDebug property can be found at [/js/background/application.js](https://github.com/MeoMix/StreamusChromeExtension/blob/Development/src/js/background/application.js).

Testing

Test cases may be ran by navigating to chrome-extension://jbnkffmindojffecdhbbmekbmkkfpmjd/test.html, but only after the extension package has been loaded into Google Chrome.

Libraries

Streamus uses a fair number of third-party JavaScript libraries. Introduction of additional libraries for off-the-shelf functionality is discouraged. Non-core libraries may be removed in the near future and additional functionality should not be implemented with them.

Core

* [jQuery](http://jquery.com/) * [Backbone](http://backbonejs.org/) * [Marionette](http://marionettejs.com) * [Lo-Dash](http://lodash.com/) * [Require](http://requirejs.org/) * [Text](https://github.com/requirejs/text)

Non-core

* [Backbone LocalStorage](https://github.com/jeromegn/Backbone.localStorage) * [jQuery UI](http://jqueryui.com/) * [jQuery Perfect Scrollbar](http://noraesae.github.io/perfect-scrollbar/) * [jQuery qTip](http://qtip2.com/)

Testing

* [Mocha](http://visionmedia.github.io/mocha/) * [Chai](http://chaijs.com/) * [Sinon](http://sinonjs.org/)

Authors

• MeoMix

with translation support provided by a community of volunteers.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use any files in this repository except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.