https://github.com/joenas/first-deadly-sin

(Faye & Sinatra) MPD web-client
https://github.com/joenas/first-deadly-sin

Last synced: 2 months ago
JSON representation

(Faye & Sinatra) MPD web-client

• Host: GitHub
• URL: https://github.com/joenas/first-deadly-sin
• Owner: joenas
• Created: 2013-03-10T22:42:52.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2023-01-18T21:38:42.000Z (almost 2 years ago)
• Last Synced: 2024-10-04T18:48:57.970Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 1.96 MB
• Stars: 7
• Watchers: 3
• Forks: 0
• Open Issues: 17
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# the First Deadly Sin[\*](http://www.imdb.com/title/tt0080738/)

This is a Sinatra web client for a remote or local MPD, with Faye for syncing between clients.

Layout and image fetching is a shameless rip-off of [So-nice](https://github.com/sunny/so-nice).

In Ubuntu, this integrates nicely with [Fogger](https://apps.ubuntu.com/cat/applications/fogger/).

On Mac OS X you can try [Fluid](http://fluidapp.com/).

Thanks to the awesome callbacks of [ruby-mpd](https://github.com/archSeer/ruby-mpd) this app now uses a MPD listener to push changes to all clients.

For a version that uses Redis and a stores the artists images locally, checkout branch [local_store](https://github.com/joenas/first-deadly-sin/tree/local_store).

# Spotify

You need to create a [Spotify application](https://developer.spotify.com/my-applications) to obtain a Client ID and Client Secret. Spotify is used to fetch artist images, since Last FM [removed their support](https://www.reddit.com/r/lastfm/comments/bjwcqh/api_announcement_lastfm_support_community/) for this.

# Usage

```bash

# Build the client

(cd client && yarn && yarn build)

# Server #

cd server

# Add your Spotify credentials

cp .env.example .env

# Install gems

bundle install

# Start server

foreman start

# or if you already have Faye running (on port 9292)

bundle exec thin start (-p port)

```

# Docker

To run the server in Docker, use the included `docker-compose.yml`.

You also need to set `FAYE_SERVER_URL=http://faye:9292/faye` in `.env`, because of the internal network.

```bash

# Choose whatever name you prefer, edit in docker-compose.yml

docker network create firstdeadlysin

docker-compose build

docker-compose up -d

```

If you want to build the images and start them yourself, for example if you don't want to keep the source code.

```bash

docker build -t first-deadly-sin_web -f Dockerfile.server .

docker build -t first-deadly-sin_faye -f Dockerfile.faye .

```

Then use as such

```yaml

version: "3.2"

services:

  web:

    image: first-deadly-sin_web

    env_file:

      - ./.env

    ports:

      - "4000:4000"

    environment:

      PORT: 4000

  faye:

    image: first-deadly-sin_faye

    env_file:

      - ./.env

    ports:

      - "9292:9292"

networks:

  default:

    external:

      name: firstdeadlysin

```

# Development

Start the client

```

# Client

cd client

yarn

yarn start

```

Start servers, with Foreman

```bash

cd server

foreman start -f Procfile

```

or separately

```

# Server

cd server

bundle exec thin start -p 4000

rackup faye.ru -E production

```

## Gotchas

- Error installing `thin` on macOS Big Sur - [link](https://github.com/macournoyer/thin/issues/365#issuecomment-692063842)

- Use `0.0.0.0` for Faye - [link](https://github.com/faye/faye/commit/fc6481be4374845c45ba3b5222efed43c378a505)