Go to file
Eliot Berriot 4992029c8a
Ignore useless files
2018-02-18 22:05:35 +01:00
api Version bump and changelog 2018-02-18 14:48:38 +01:00
demo
deploy
docker/nginx
docs
front Removed useless log 2018-02-18 15:31:37 +01:00
.dockerignore
.editorconfig
.env.dev Removed now useless BACKEND_URL setting 2018-02-18 14:42:17 +01:00
.gitattributes
.gitignore Ignore useless files 2018-02-18 22:05:35 +01:00
.gitlab-ci.yml
CHANGELOG Now reset player colors when track has no coverNow reset player colors when track has no cover 2018-02-18 15:09:03 +01:00
CONTRIBUTORS.txt
LICENSE
README.rst
dev.yml

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