Go to file
Eliot Berriot 99f33dd392
Make api docker image able to run tests
2018-03-12 23:07:08 +01:00
api Make api docker image able to run tests 2018-03-12 23:07:08 +01:00
changes Fix #117: Use django-cacheops to cache common ORM requests 2018-03-08 23:21:59 +01:00
demo Demo is back 2018-03-06 21:33:50 +01:00
deploy Fix #110: completely removed django cachalot 2018-03-06 20:51:28 +01:00
docker/nginx Initial channels integration 2018-03-01 18:38:31 +01:00
docs Merge branch '111-skip-acoustid' into 'develop' 2018-03-06 20:54:28 +00:00
front Merge branch '114-exclude-empty-albums' into 'develop' 2018-03-07 22:19:21 +00: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 Fix #110: completely removed django cachalot 2018-03-06 20:51:28 +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 data 2018-03-06 20:26:51 +01:00
.gitlab-ci.yml Fix #117: Use django-cacheops to cache common ORM requests 2018-03-08 23:21:59 +01:00
CHANGELOG Version bump and changelog 2018-03-06 21:56:01 +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 Minor fixes to docker setup 2018-03-02 00:14:55 +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