funkwhale

Go to file

Eliot Berriot a91a8b7906 Merge tag '0.2.3' into develop - lazyloading images - artist browsing - better pagination - fixed multiple warnings		2017-12-12 23:55:23 +01:00
api	version bump	2017-12-12 23:54:57 +01:00
demo	Fixed a typo in track importing instructions	2017-06-25 23:39:18 +02:00
deploy	Now return media files with absolute URL	2017-07-11 09:14:54 +02:00
docker/nginx	Now return media files with absolute URL	2017-07-11 09:14:54 +02:00
docs	Changelog && version bump	2017-07-17 22:08:44 +02:00
front	Merge branch 'develop' of ssh://code.eliotberriot.com:2222/funkwhale/funkwhale into develop	2017-12-12 23:54:21 +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	Fixed #4 : can now import artists and releases with a clean interface :party:	2017-07-09 11:33:33 +02: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	Added documentation about music acquisition	2017-06-25 23:33:19 +02:00
.gitlab-ci.yml	Added missing script	2017-07-17 22:01:57 +02: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	Now return media files with absolute URL	2017-07-11 09:14:54 +02: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