Skip to content

DakaraProject/dakara-server

Repository files navigation

Dakara server

Tests status Codecov coverage analysis Code style: black Imports: isort

Server for the Dakara project.

Installation

To install Dakara completely, you have to get all the parts of the project. Installation guidelines are provided over here:

System requirements

  • Python3, to make everything up and running (supported versions: 3.8, 3.9, 3.10, 3.11, and 3.12).

Linux, Mac and Windows are supported.

Virtual environment

It is strongly recommended to run the Dakara server in a virtual environment.

Dependencies

Having a recent enough versio of pip is required to install some dependencies properly:

pip install --upgrade pip

Install dependencies, at the root level of the repo (in the virtual environment):

pip install -r requirements.txt

Setting up the server

Let's create the server database, after loading the virtual environment, do:

dakara_server/manage.py migrate

You should be asked to create a super user. Do it. Otherwise:

dakara_server/manage.py createsuperuser

Start the server

You're almost done! To start the server app, in the right virtual environment, do:

dakara_server/manage.py runserver

The server part is now set up correctly.

Web client, Feeder and player

Now setup the web client, feeder and player according to their respective documentations. The feeder can authenticate to the server using a token, or a couple login/password, of a playlist manager account. The player can authenticate using a special token that only a playlist manager can generate. Both token can be obtained from the web interface.

After all of this is setup, just grab some friends and have fun!

Development

Please read the developers documentation.