sunilkum84 / go_clean_architecture Goto Github PK

Clean Architecture with Golang with Dependency Injection

To install all the packages and run the linter in git pre-commit hook; Run

Make lint-setup

⚓️   Add argument p=host after make if you want to run the migration runner from the host environment instead of docker environment. example; make p=host migrate-up

If you are not using docker; ensure that sql-migrate is installed to use migration from the host environment. To install sql-migrate:

go get -v github.com/rubenv/sql-migrate/...

• Update database env variables with credentials defined in docker-compose.yml
• Start server using command docker-compose up -d or sudo docker-compose up -d if permission issues

  Assumes: Docker is already installed in the machine.

• Run go run main.go app:serve to run app server.
• There are other commands available as well. You can run go run main.go -help to know about other commands available.

The framework comes with unit and integration testing support out of the box. You can check examples written in tests directory. To run the test just run: go test ./... -v

• go test ./... -v -coverprofile cover.txt -coverpkg=./...
• go tool cover -html=cover.txt -o index.html

Browse to http://localhost:${SWAGGER_PORT}

• You can see all the documented endpoints in Swagger-UI from the API specification
• You can execute/test endpoint You can read the article to know more on this: https://medium.com/wesionary-team/swagger-ui-on-docker-for-testing-rest-apis-5b3d5fcdee7