JamFactory Backend

Checkout the live version on Jamfactory.app

What is JamFactory?

JamFactory is a collaborative playback controller. A JamSession is a private party with one host to set it up, and many attendees to join in.

Your friends or party guests can vote for the songs they like and want to listen to, and the song with the most votes gets played next. JamFactory acts as the conductor of your music and is not the playback device itself. Therefore, you are free to choose your own playback device.

The host of a JamSession has to have a Spotify premium account, the guests can join the JamSession without a Spotify account.

JamFactory consists of independent applications that form the ecosystem together. This project contains the backend that provides the necessary API to create, join and control a JamSession. It also acts as the Conductor that controls the playback and communicates to the Spotify api.

Built with

JamFactory is built among others using these awesome projects:

• Go
• zmb3/spotify
• Gorilla
• Redis

Latest Release

v0.2.0 Release Notes

Getting started

To understand how the JamFactory backend works, which API Endpoints are available and how it can be used to create a JamSession, read the Documentation.

Installation

The JamFactory backend can either be deployed using Docker (recommended) or installed from sources. Helm charts for Kubernetes deployments are available at JamFactoryApp/jamfactory-helm.

Initial setup

• Clone the repository to your desired location

  git clone https://github.com/JamFactoryApp/jamfactory-backend.git

• Create a Spotify App on the Developer Dashboard

• Create a .env file and fill out the information. See .env.example for an example .env file. It is recommended to use a very long password for the Redis db.

Docker installation

• Create a users.acl file in the /redis folder. Make sure to use the same password as in the .env file. See users.acl.example for an example users.acl file.

• Create and start the Docker containers using docker-compose up -d

Local installation

• Make sure you have a proper Go installation setup: https://golang.org/doc/install.
• Run go install ./cmd/jamfactory to install the JamFactory backend to your $GOPATH/bin directory.