novaburst/funquail
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
Federated music sharing platform hard-forked from Funkwhale --- MAIN REPOSITORY: https://git.prometheus.systems/funquail-team/funquail --- https://funquail.frama.io
246 commits 1 branch 0 tags 50 MiB
  • Python 65.4%
  • Vue 27%
  • TypeScript 4.9%
  • SCSS 1.5%
  • HTML 0.5%
  • Other 0.5%
Find a file
Eliot Berriot 9a69a8f581
 Merge tag '0.4' into develop 
0.4 (2018-02-18)
----------------

- Front: ambiant colors in player based on current track cover (#59)
- Front: simplified front dev setup thanks to webpack proxy (#59)
- Front: added some unittests for the store (#55)
- Front: fixed broken login redirection when 401
- Front: Removed autoplay on page reload
- API: Added a /instance/settings endpoint
- Front: load /instance/settings on page load
- Added settings to report JS and Python error to a Sentry instance
  This is disabled by default, but feel free to enable it if you want
  to help us by sending your error reports :) (#8)
2018-02-18 14:49:03 +01:00
api Version bump and changelog 2018-02-18 14:48:38 +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 Use webpack dev proxy to serve api/media 2018-02-18 14:42:17 +01:00
docs WIP: Debian installation instructions 2017-07-20 23:30:25 +02:00
front Fix #59: Use color-thief for setting player colors based on track cover 2018-02-18 14:42:18 +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 Removed now useless BACKEND_URL setting 2018-02-18 14:42:17 +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 Can now configure allowed host in all settings 2018-02-18 14:42:17 +01:00
CHANGELOG Version bump and changelog 2018-02-18 14:48:38 +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
dev.yml Use webpack dev proxy to serve api/media 2018-02-18 14:42:17 +01: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

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