Fela Maslen b624febd05 chore: use dev database port when connecting, if available %!s(int64=4) %!d(string=hai) anos
..
certificates ab61154b2b feat: flutter mobile app %!s(int64=4) %!d(string=hai) anos
cmd a958d33941 feat: skip to next / previous song %!s(int64=5) %!d(string=hai) anos
migrations a958d33941 feat: skip to next / previous song %!s(int64=5) %!d(string=hai) anos
pkg b624febd05 chore: use dev database port when connecting, if available %!s(int64=4) %!d(string=hai) anos
.dockerignore 6ae2b251e3 Refactor/project structure (#3) %!s(int64=5) %!d(string=hai) anos
.gitignore 6ae2b251e3 Refactor/project structure (#3) %!s(int64=5) %!d(string=hai) anos
Dockerfile 3810564d53 feat: continuous integration and kubernetes config %!s(int64=5) %!d(string=hai) anos
Makefile 3810564d53 feat: continuous integration and kubernetes config %!s(int64=5) %!d(string=hai) anos
README.md a958d33941 feat: skip to next / previous song %!s(int64=5) %!d(string=hai) anos
ci.env 3810564d53 feat: continuous integration and kubernetes config %!s(int64=5) %!d(string=hai) anos
docker-compose.yml 5e38bc80e2 feat: optional custom dev database port %!s(int64=4) %!d(string=hai) anos
example.env 6ae2b251e3 Refactor/project structure (#3) %!s(int64=5) %!d(string=hai) anos
go.mod 1b15dfcbfe feat: play queue %!s(int64=5) %!d(string=hai) anos
go.sum 1b15dfcbfe feat: play queue %!s(int64=5) %!d(string=hai) anos
init.sql 6ae2b251e3 Refactor/project structure (#3) %!s(int64=5) %!d(string=hai) anos
nginx.conf ab61154b2b feat: flutter mobile app %!s(int64=4) %!d(string=hai) anos
test.env 6ae2b251e3 Refactor/project structure (#3) %!s(int64=5) %!d(string=hai) anos

README.md

gmus-backend

This is the backend part of the music player, written in Golang.

Building

Run make build inside this directory. Binaries will be built and output to the bin directory (which will be created if it does not exist).

Testing

Run make test inside this directory, to run unit and integration tests.

Migrations

First, make sure the following environment variables are set:

  • POSTGRES_HOST
  • POSTGRES_USER
  • POSTGRES_PASSWORD
  • POSTGRES_PORT (optional, defaults to 5432)
  • POSTGRES_DATABASE

Then, run:

  • make migrate

Creating migrations

After getting the migrate CLI tool, run:

  • NAME=create_some_table make migrate.make

Components

Music scanner

This is intended to be run as a scheduled job. It will scan a directory and add relevant metadata to a PostgreSQL database.

Development usage

make run.scan

REST/WebSocket API

Development usage

make run.server

This is an HTTP server running the following endpoints:

GET /stream?songid=<id>

Streams an audio file based on the songid value in the query string.

GET /pubsub

Handles long-running client connections, initiating a websocket.

GET /artists

Fetches all artists, and outputs them in JSON format.

GET /albums?artist=<artist>

Fetches albums for a particular artist, and outputs them in JSON format.

GET /songs?artist=<artist>

Fetches songs for a particular artist, and outputs them in JSON format.

GET /song-info?id=<id>

Fetches info for a particular song, based on its ID, and outputs it in JSON format.

GET /next-song?id=<id>

Fetches next song info.

GET /prev-song?id=<id>

Fetches previous song info.