Go to file
Eliot Berriot d60804c9db
Added raven on server side
2018-02-17 21:31:33 +01:00
api Added raven on server side 2018-02-17 21:31:33 +01:00
demo Fixed a typo in track importing instructions 2017-06-25 23:39:18 +02:00
deploy Added raven on server side 2018-02-17 21:31:33 +01:00
docker/nginx Brand new file importer 2017-12-27 23:32:02 +01:00
docs WIP: Debian installation instructions 2017-07-20 23:30:25 +02:00
front Now use raven-js on frontend 2018-02-17 21:31:32 +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 Added raven on server side 2018-02-17 21:31:33 +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 Added documentation about music acquisition 2017-06-25 23:33:19 +02:00
.gitlab-ci.yml Should now run frontend tests on gitlab 2018-01-09 21:11:45 +01:00
CHANGELOG Removed autoplay on page reload 2018-02-17 17:30:21 +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 Initial setup for phtantomjs 2018-01-08 22:47:14 +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