Startseite Erkunden Hilfe
Registrieren Anmelden
felamaslen
/
go-music-player
1
0
Fork 0
Dateien Issues 0 Pull-Requests 1 Wiki
Branch: feature/next-previous
Branches Tags
go-music-pla...
/
gmus-backend
Fela Maslen 1778e24fe2 refactor: less verbose next/previous song queries vor 5 Jahren
..
cmd b60d1ed3c9 chore: prefixed commands vor 5 Jahren
migrations f5859a5a47 feat: indexes on track number, title, artist and album vor 5 Jahren
pkg 1778e24fe2 refactor: less verbose next/previous song queries vor 5 Jahren
.dockerignore 6ae2b251e3 Refactor/project structure (#3) vor 5 Jahren
.gitignore 6ae2b251e3 Refactor/project structure (#3) vor 5 Jahren
Dockerfile b60d1ed3c9 chore: prefixed commands vor 5 Jahren
Makefile b60d1ed3c9 chore: prefixed commands vor 5 Jahren
README.md 3e6e3a468f feat: routes to get next and previous song info vor 5 Jahren
docker-compose.yml bf664f7816 fix: set API port by default on development to 3002 vor 5 Jahren
example.env 6ae2b251e3 Refactor/project structure (#3) vor 5 Jahren
go.mod 6ae2b251e3 Refactor/project structure (#3) vor 5 Jahren
go.sum 6ae2b251e3 Refactor/project structure (#3) vor 5 Jahren
init.sql 6ae2b251e3 Refactor/project structure (#3) vor 5 Jahren
test.env 6ae2b251e3 Refactor/project structure (#3) vor 5 Jahren

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.