JukeB0X : mp3 library API

Autumn 2019 -- Everarts de Velp Guillaume

JukeB0X is a simple REST API that allows to upload mp3 files and retrieve them. This solution is presented under a docker container shape to make easier the deployment of the app.

You can find the detailed API here.

Installation

To create the docker container image, in the project folder, simply run :

docker build -t jukeb0x .

To run a container you then have to type :

docker run -d -p 80:80 jukeb0x

💡 Installation check : simply open your browser and visit this link : http://localhost/ok

💡 Tips : To make the library survive a container failure or to share it between multiple one, you can mount a directory of your host system to act as the library doing so :

docker run -d -p 80:80 --mount type=bind,source=/your/path/to/folder,target=/usr/src/jukeB0X/library jukeb0x

Contributing

This project is developed without any guarantee of further improvement of maintenance. If you want to help your help is welcome, you can start by posting issues and pull requests.

License

This project is under MIT license, feel free to use it at your own will.