Skip to content

Latest commit

 

History

History
86 lines (68 loc) · 3.33 KB

README.md

File metadata and controls

86 lines (68 loc) · 3.33 KB
Raw

Streamus - Website

The website for Streamus - The most popular Chrome extension YouTube music player

Overview

The Streamus website consists of:

  • Home: An introduction to Streamus and a download button.
  • Getting Started: A more in-depth introduction to Streamus accompanied by screenshots.
  • FAQ: Responses to commonly asked feature requests and troubleshooting inquiries.
  • Share: A page which allows users to share playlists with others.
  • About: An outline of the project as well as the developer behind it.
  • Donate: A donation page which supports PayPal and Bitcoin.

Development

  1. Ensure you have Node, NPM, and Grunt installed.
  2. Run "npm install" to install necessary dependencies.
  3. Install Apache 2.4 and configure it such that it can find src/index.html
  4. Run "grunt less" and then "grunt watch" to compile LESS to CSS and monitor for changes.
  5. Navigate to src.streamus.com in your browser.
  6. To build a release, run "grunt build". Versioning is not yet supported.

Apache Configuration for Windows: In order to develop Streamus' website properly you'll need to configure Apache. A few things are needed:

  • You'll want to navigate to your hosts file and add entries for: "127.0.0.1 src.streamus.com" and "127.0.0.1 dist.streamus.com". This will allow for named websites instead of just localhost which helps satisfy CORS.
  • You then need to modify your VHosts to expect these websites. My config looks like:
<VirtualHost src.streamus.com:80=''>
  DocumentRoot "${WEBSITEROOT}/src"
  ServerName src.streamus.com
</VirtualHost>

<VirtualHost dist.streamus.com:80=''>
  DocumentRoot "${WEBSITEROOT}/dist"
  ServerName dist.streamus.com
</VirtualHost>

where WEBSITEROOT points to my src directory such as:

Define WEBSITEROOT "/Users/Meo/Documents/GitHub/StreamusWebsite"

Server settings: Be sure to set localDebug to false in application.js unless you have a local instance of Streamus' server running.

Third-Party Libraries

Streamus Website utilizes several third-party libraries:

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.