Skip to content
A self hosted music streaming server
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app fix issue of normal user can not see page of settings Jul 16, 2019
bin update webpacker to 4.0 Apr 20, 2019
config add setting for theme and update rails-settings-cached to 2.0 Jul 16, 2019
db fix error on docker production image May 27, 2019
images update logo and screenshot Jun 23, 2019
lib fix errors on travis ci May 13, 2019
log setup the basic environment Feb 7, 2018
public add custom style error pages Apr 24, 2019
test fix issue of normal user can not see page of settings Jul 16, 2019
tmp setup the basic environment Feb 7, 2018
vendor setup the basic environment Feb 7, 2018
.dockerignore add test and images dir to dockerignore Jun 23, 2019
.eslintrc.js fix playlist update issue when add song to the playlist May 4, 2019
.gitignore add production task on Makefile Jun 26, 2019
.rubocop.yml add docker support for development Dec 30, 2018
.stylelintrc add list and heading css component Mar 25, 2019
.travis.yml add test for artist model and album model Jun 6, 2019
Dockerfile add fake secure key base for assets precompile Jun 4, 2019
Gemfile add setting for theme and update rails-settings-cached to 2.0 Jul 16, 2019
Gemfile.lock add setting for theme and update rails-settings-cached to 2.0 Jul 16, 2019
LICENSE update Readme Jun 23, 2019
Makefile add production task on Makefile Jun 26, 2019
README.md update readme Jul 6, 2019
Rakefile refactor code for sync song from local file Jul 11, 2018
VERSION bump version to 1.0.1 Jun 30, 2019
babel.config.js upgrade webpacker to 4.0.7 Jun 4, 2019
base.Dockerfile add vim base image Jun 4, 2019
config.ru refactor code for sync song from local file Jul 11, 2018
docker-compose.development.yml add Makefile for docker task May 21, 2019
docker-compose.test.yml add test for searchable and playlistable concerns Jun 16, 2019
docker-compose.yml add config for secret_key_base Jun 4, 2019
package.json upgrade webpacker to 4.0.7 Jun 4, 2019
postcss.config.js update webpacker to 4.0 Apr 20, 2019
web.Dockerfile bump version to 1.0.0 Jun 23, 2019
yarn.lock upgrade webpacker to 4.0.7 Jun 4, 2019

README.md

Black candy logo

Black candy

Build status

Black candy is a self hosted music streaming server built with Rails and Stimulus. The goal of the project is to create a real personal music center.

Screenshot

screenshot

Demo

Try the demo (email: foo@bar.com, password: foobar)

Note: Please do not change the password on demo, avoid others can not visit it.

List for all music on the demo:

If like their music, you can buy their albums to support them.

Getting started

Black candy use docker for simplify deployment, development and test process. So you should install docker and docker-compose first.

Black candy support mp3, m4a, ogg, flac and wav formats now.

Installation

Black candy has built docker images.

First, you need clone this project to your server.

$ git clone https://github.com/aidewoode/black_candy.git

Second, set BLACK_CANDY_MEDIA_PATH and BLACK_CANDY_SECRET_KEY_BASE environment variable on your sever and point BLACK_CANDY_MEDIA_PATH to the readable directory on your server to store your music files.

# Like this
$ export BLACK_CANDY_MEDIA_PATH="/example_media_path"
$ export BLACK_CANDY_SECRET_KEY_BASE="your_secret_key"

Then, you should setup database

$ make production_setup 

Finally run:

$ docker-compose up -d

# or

$ make production_run

That's all.

You can use initial admin user to login (email: admin@admin.com, password: foobar).

You can also change docker-compose.yml for your own needs.

Development

# Clone the repo
$ git clone https://github.com/aidewoode/black_candy.git

# Setup development environment
$ make dev_setup

# Runing development server
$ make dev_run

# Stop development server
$ make dev_stop

# Into development shell
$ make dev_shell

Test

# Setup test environment
$ make test_setup

# Runing test
$ make test_run

# Runing lint
$ make test_run_lint

# Into test shell
$ make test_shell

Integrations

Black candy support get artist and album image from Discogs API. You can create a API token from Discogs and set Discogs token on Setting page to enable it.

You can’t perform that action at this time.