spotify-gui/canvas/README.md

Spotify Canvas Downloader

Tool to get Canvas cover videos from Spotify tracks.

✨ Try it out

Building

• Clone the repository

  git clone https://github.com/Delitefully/spotify-canvas-downloader
  

• Configure the env variables

  mv env.example .env
  

• Build the image using Docker Compose

  docker-compose up
  

Development

Recompile protocol buffer proto (useful when upgrading protobuff):

protoc ./protos/canvas.proto  --python_out=./src/

Requires the Protocol Buffers package.

API

GET /api/canvas/:trackId

Returns

{
    "success": boolean
    "canvas_url": string, if success is 'true'
    "message": string, error message if success is 'false'
}