/go-api

Primary LanguageGo

capo-music/Boilerplate For Golang Projects

Build Status Maintainability Rating Test Coverage Go Report Card

Blog Post - More Information About This Repo

You can find more information about this project/repository and how to use it in few blog post:

Setting Up

  • Replace All Occurrences of webnator/capo-music-api with your username repository name
  • Replace All Occurrences of capo-music with your desired image name

Adding New Libraries/Dependencies

go mod vendor

Using GitHub Registry

Create and Push:

docker login docker.pkg.github.com -u <USERNAME> -p <GITHUB_TOKEN>
docker build -t  docker.pkg.github.com/webnator/capo-music-api/capo-music:latest .
# make container
docker push docker.pkg.github.com/webnator/capo-music-api/capo-music:latest
# make push

Pull and Run:

docker pull docker.pkg.github.com/webnator/capo-music-api/capo-music:latest
docker run -p 1234:1234 \
           -e capo-music_DSN="postgres://<USER>:<PASSWORD>@<DOCKER_SERVICE/URL>:<PORT>/<DB>?sslmode=disable" \
           docker.pkg.github.com/webnator/capo-music-api/capo-music:latest

Setup new SonarCloud Project

  • On SonarCloud:
    • Click Plus Sign in Upper Right Corner
    • Analyze New Project
    • Click GitHub app configuration link
    • Configure SonarCloud
    • Select Repository and Save
    • Go Back to Analyze Project
    • Tick Newly Added Repository
    • Click Set Up
    • Click Configure with Travis
    • Copy the Command to Encrypt the Travis Token
    • Run travis encrypt --com <TOKEN_YOU_COPPIED>
    • Populate the secure Field in .travis.yml with outputted string
    • Follow steps to populate your sonar-project.properties
    • Push
  • On Travis CI:
    • Set DOCKER_USERNAME
    • Set DOCKER_PASSWORD to Your GitHub Registry Token

Setup CodeClimate

  • Go to https://codeclimate.com/github/repos/new
  • Add Repository
  • Go to Test Coverage Tab
  • Copy Test Reporter ID
  • Go to Travis and Open Settings for Your Repository
  • Add Environment Variable: name: CC_TEST_REPORTER_ID, value: Copied from CodeClimate

Swagger

  • Application uses gin-swagger.
  • To generate/update docs use swag init (from backend/cmd/backend)
  • You can find generated docs in docs package

To view docs, navigate to http://localhost:1234/swagger/index.html or to http://localhost:1234/swagger/doc.json for raw JSON