Go to file
Eliot Berriot 20eaa5e615
Merge branch 'release/0.2.5'
2017-12-16 16:15:40 +01:00
api Version bump and changelog 2017-12-16 16:15:33 +01:00
demo Fixed a typo in track importing instructions 2017-06-25 23:39:18 +02:00
deploy WIP: Debian installation instructions 2017-07-20 23:30:25 +02:00
docker/nginx Now return media files with absolute URL 2017-07-11 09:14:54 +02:00
docs WIP: Debian installation instructions 2017-07-20 23:30:25 +02:00
front Fixed #48: basic 404 error template 2017-12-15 22:45:33 +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 Fixed broken Gitlab CI build and added pip cache 2017-12-16 16:10:48 +01:00
CHANGELOG Version bump and changelog 2017-12-16 16:15:33 +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 Fixed #7: store release-group id on Album 2017-12-13 23:36:10 +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