Skip to content

Latest commit

 

History

History
115 lines (85 loc) · 4.62 KB

README.md

File metadata and controls

115 lines (85 loc) · 4.62 KB
Raw

Apollo Player

Opensource community driven playlist using Spotify, Mopidy, Node.js and Backbone.js

alt text

alt text

Features

  • Simple and elegant group playlist
  • Song Bombs = 3 (configurable) unique votes skips the track and "boos" the player
  • Search keywords or Spotify URI's
  • Support for multiple backends (merged from https://github.com/lemmy/Apollo-Player/)
  • Play / Pause toggle
  • Default Playlist (plays when Apollo runs out of songs to play) (optional)

Get Started

Prerequisites

  1. Don't talk about Fight Club.
  2. You'll need to have a basic understanding of Node and Node's package manager.

I'll add that I didn't have a basic understanding of Node at all before this project and used Apollo to help me learn it... So there's hope for you too!

Install and configure Mopidy

First we'll need to install Mopidy. Mopidy is a opensource music server that you can connect to many "frontends" or roll your own, which what Apollo is. To read more about Mopidy go here.

  1. Install Mopidy. Mopidy is an opensource music server that installable on OSX, Debian/Ubuntu, Rasberry Pi. *note: so far we've only tested on Debian and OSX.
    1. You'll need to do the Spotify installation
    2. Next you'll need to enable http on Mopidy
  2. Start Mopidy on the commandline (if this doesn't work check the mopidy docs, probably a python path issue.) 
    $ mopidy
  3. Optional: You'll want to have Mopidy running in the background at all times for Apollo to work. You'll want to look into making Mopidy a Daemon so that if it crashes it will auto-restart.

Install Apollo

Now that you have Mopidy up and running, let's setup up Apollo as our Frontend for it.

  1. Clone Apollo to a local folder

    $ git clone https://github.com/samcreate/Apollo-Player.git

$ cd Apollo-Player

  2. Install Node dependencies

    $ npm install

  3. Configure Apollo

    1. Create a Google Project
      1. Create a new Google Project
      2. Go to the Credentials section under ApIs & Auth.
      3. Click create new Client ID
      4. Select Web Application
        1. Authorized Javascript origins: must match the origin for your requests
        2. Authorized Redirect URIS: a public facing url or private IP to which google redirect the user during the auth callback (must end in /auth/google/callback)
    2. Create a file called config.js in root directory of Apollo
    $ touch config.js (or just create it with an editor)

    1. add this structure into config.js file:

      var config = {
  development: {
    server: {
      host: "localhost",
      port: 3000,
    },
    "callback":"THE CALLBACKURL CONFIGURED IN THE GOOGLE PROJECT"
    "consumerKey":"YOUR GOOGLE CLIENT ID",
    "consumerSecret":"YOUR GOOGLE CLIENT SECRET",
    "default_playlist_uri":"SPOTIFY URI TO DEFAULT PLAY LIST (cannot be private!)", (optional)
    "htmlPretty": "true", (optional)
    "bombThreshold": 3, (optional)
    "bomb_track": "SPOTIFY TRACK TO PLAY ON BOMBING" (optional default is "spotify:track:1JFeNGtkTjiTWgSSz0iHq5")
  }
};

module.exports = config[process.env.NODE_ENV || 'development'];

    2. Add your Spotify default playlist uri (this has to be a public playlist to work). This is what plays when all the songs in the queue have finished playing (optional)

  4. Start Apollo

    $ node apollo.js

Once Apollo is started, navigate to your localhost: http://localhost:3000

Optionally on Debian/Ubuntu, you might want to start Apollo as a system service.

Finished!

Notes

  • If you change a value in config.js, you'll need to restart node (ctrl+c)
  • Apollo works best in Chrome.

Tech used

  • Frontend: Backbone, RequireJS, Bootstrap, Handelbars, Jade templating and stylus
  • Backend: Node.js, ExpressJS

Help? Bugs?