funkwhale

Go to file

Eliot Berriot 6f9074584a Merge branch '88-exclude-empty-radio' into 'develop' Fixed #88: Now exclude tracks without file from radio candidates Closes #88 See merge request funkwhale/funkwhale!62		2018-02-27 18:39:25 +00:00
api	Fixed #88 : Now exclude tracks without file from radio candidates	2018-02-27 19:20:55 +01:00
changes	Merge branch '88-exclude-empty-radio' into 'develop'	2018-02-27 18:39:25 +00:00
demo	Fixed a typo in track importing instructions	2017-06-25 23:39:18 +02:00
deploy	Updated sample nginx conf	2018-02-24 16:57:01 +01:00
docker/nginx	Nginx configuration to cache transcoded media	2018-02-19 21:21:05 +01:00
docs	Fixed #85 : broken documentation	2018-02-27 13:18:49 +01:00
front	Fixed #83 : click event outside of player icons	2018-02-27 19:18:24 +01:00
.dockerignore	Initial commit that merge both the front end and the API in the same repository	2017-06-23 23:00:42 +02:00
.editorconfig	Initial commit that merge both the front end and the API in the same repository	2017-06-23 23:00:42 +02:00
.env.dev	Removed now useless BACKEND_URL setting	2018-02-18 14:42:17 +01:00
.gitattributes	Initial commit that merge both the front end and the API in the same repository	2017-06-23 23:00:42 +02:00
.gitignore	Ignore useless files	2018-02-18 22:05:35 +01:00
.gitlab-ci.yml	Can now configure allowed host in all settings	2018-02-18 14:42:17 +01:00
CHANGELOG	Now use towncrier for changelog management	2018-02-27 19:04:50 +01:00
CONTRIBUTORS.txt	Initial commit that merge both the front end and the API in the same repository	2017-06-23 23:00:42 +02:00
LICENSE	Initial commit that merge both the front end and the API in the same repository	2017-06-23 23:00:42 +02:00
README.rst	Initial commit that merge both the front end and the API in the same repository	2017-06-23 23:00:42 +02:00
dev.yml	Use webpack dev proxy to serve api/media	2018-02-18 14:42:17 +01:00
pyproject.toml	Now use towncrier for changelog management	2018-02-27 19:04:50 +01:00

README.rst

Funkwhale
=============

A self-hosted tribute to Grooveshark.com.

LICENSE: BSD

Setting up a development environment (docker)
----------------------------------------------

First of all, pull the repository.

Then, pull and build all the containers::

    docker-compose -f dev.yml build
    docker-compose -f dev.yml pull


API setup
^^^^^^^^^^

You'll have apply database migrations::

    docker-compose -f dev.yml run celeryworker python manage.py migrate

And to create an admin user::

    docker-compose -f dev.yml run celeryworker python manage.py createsuperuser


Launch all services
^^^^^^^^^^^^^^^^^^^

Then you can run everything with::

    docker-compose up

The API server will be accessible at http://localhost:6001, and the front-end at http://localhost:8080.

Running API tests
------------------

Everything is managed using docker and docker-compose, just run::

    ./api/runtests

This bash script invoke `python manage.py test` in a docker container under the hood, so you can use
traditional django test arguments and options, such as::

    ./api/runtests funkwhale_api.music   # run a specific app test