Music Stream Svelte

Table of Contents

• What is this?
• Tech Stack
• Features
• Prequisites
• Installation
  • Docker
  • Manual
  • Development

What is this?

A self-hosted music streaming service built with SvelteKit that allows you to stream the music stored on your computer/home server to any device with a browser. 🎶

Tech Stack

• SvelteKit (TypeScript)
• TailwindCSS
• Prisma (PostgreSQL)

Features

• Responsive design
• User authentication
• Streaming music
• Playlists
• Search
• Album covers through MusicBrainz API

Prequisites

• Only Linux is supported unless you use the docker image
• Proper metadata for your music files (artist, album, title)
• Album covers are fetched from MusicBrainz API, so it's recommended to have the correct album and artist names
• Music files must be stored in a directory that is accessible and modifiable by the server
• Music files must be of the following formats: mp3, flac, wav
• No folder that contains music files should start with a . or -

Installation

After installation

• The server will be running on port 3000
• If it is a new installation, you will be redirected to the setup page
• Create an owner account and make sure to give a real email address (it is used for MusicBrainz API request headers)

Docker

• Install Docker
• With docker run

make sure to replace /path/to/music with the path to your music directory

if you want to persist db in a known location or a named volume replace /path/to/db/data with the path to the folder or the name of the volume otherwise you can remove the volume flag

docker run -d \
  -p 3000:3000 \
  -v /path/to/music:/music \
  <-v /path/to/db/data:/app/db> \
  aygreyg/svelte-music-stream

• if you want the server to be accessible from localhost add -e ORIGIN=http://localhost:3000

Manual

• Install Node.js
• Clone the repository
• Install dependencies and generate prisma client:

pnpm install && pnpx prisma generate

• Build the project:

pnpm build

• If you want to remove unused dependencies run:

pnpm prune --production --ignore-scripts

• Make start.sh executable:

chmod +x start.sh

• If you only want to expose an explicit folder use MUSIC_PATH=/path/to/music
• If you want the server to be accessible from localhost add ORIGIN=http://localhost:3000
• Start the server with

 ./start.sh

Development

• Install Node.js
• Install pnpm
• Clone the repository
• Install dependencies and generate prisma client:

pnpm install && pnpx prisma generate

• Start the server with

add --host if you want to access the server from another device

pnpm dev

• If you are using a node manager (like nvm) and want to commit using a gui you might need this to make husky work