Skip to content

tphoney/musicscan

Repository files navigation

Pre-Requisites

Install the latest stable version of Node and Go version 1.16 or higher, and then install the below Go programs. Ensure the GOBIN directory is added to your PATH.

$ go install github.com/bradrydzewski/togo
$ go install github.com/golang/mock/mockgen
$ go install github.com/google/wire/cmd/wire

Build

Build the user interface:

$ cd web
$ npm install
$ npm run build
$ cd ..

Build the server and command line tools:

$ go generate ./...
$ go build -o release/musicscan

Test

Execute the unit tests:

$ go generate ./...
$ go test -v -cover ./...

Run

This project supports all operating systems and architectures supported by Go. This means you can build and run the system on your machine; docker containers are not required for local development and testing.

Start the server at localhost:3000

$ release/musicscan server

User Interface

This project includes a simple user interface for interacting with the system. When you run the application, you can access the user interface by navigating to http://localhost:3000 in your browser.

Command Line

This project includes simple command line tools for interacting with the system. Please remember that you must start the server before you can execute commands.

Register a new user:

$ release/musicscan register

Login to the application:

$ release/musicscan login

Logout from the application:

$ release/musicscan logout

View your account details:

$ release/musicscan account

Generate a peronsal access token:

$ release/musicscan token

Create a project:

$ release/musicscan project create <name>

List projects:

$ release/musicscan project ls

Debug and output http responses from the server:

$ DEBUG=true release/musicscan project ls

View all commands:

$ release/musicscan --help

About

Scans a directory and matches artists and albums via spotify

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published