froge/gomusic
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README with docker instructions

Browse source
This commit is contained in:
froge 2025-02-12 12:00:02 +10:00
parent a9e265a4f3
commit a4acb8a873
Signed by: froge
GPG key ID: A825E09930271BFA
1 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -2,7 +2,7 @@
This API supports simple artist read operations for spotify data, as well as using a simple caching database and handling client authentication automatically.
## Setup
After compiling the binary, or when executing via `go run`, just be sure to set the following environment variables to enable access to Spotify's API
After compiling the binary, or when executing via `go run`, just be sure to set the following environment variables to enable access to Spotify's API.
```
SPOTIFY_ID=<your spotify client ID>
SPOTIFY_TOKEN=<your spotify token>
@ -14,8 +14,11 @@ Example execution using the linux command line:
Alternatively you can use `go run` too:
`SPOTIFY_ID=myspotifyID SPOTIFY_TOKEN=myspotifytoken go run .`
This project has been built with docker support, and a docker image can be built using the Dockerfile provided.
Please note that the above environment variables will still need to be passed into the container for execution to work correctly.
## Testing
This application comes with a complete test suite, it can be run using the standard `go test` system
This application comes with a complete test suite, it can be run using the standard `go test` system.
When running tests you are required to provide the same credentials as when running the server normally.
For example: