Music Assistant

Music Assistant is a music player with in-real-time recommendations.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. License
6. Contact
7. Acknowledgments

About The Project

Music assistant is a final year team project for Applied Computer Science at Wrocław University of Science and Technology.

Built With

Getting Started

Prerequisites

For local development, you need docker engine installed. Follow the instructions here.

Installation

1. Clone the repo

   git clone https://gitlab.com/zpi-dev-group/backend/services

2. Create required secrets files and the .env file in project root
   TODO

3. All services are containerized and connected to each other with docker compose. To use them, run:

   docker compose --profile linux --profile nats-linux up --build

   or, for windows:

   docker compose --profile windows --profile nats-windows up --build

Usage

getting survey recommendations:

curl -X POST 'http://localhost:5000/survey/batches/?limit=10' -H 'Content-Type: application/json' -d '{
  "image_ids": ["techno1", "techno2", "techno3"],
  "batch_size": 5,
  "market": "PL"
}'

getting regular recommendations:

curl -X POST "localhost:5000/recommendations/<profile id>"

Contact

Franciszek Suszko - @sunba23 - franeksu@gmail.com
Krzysztof Głowacz - @Krisenberg