Example golang fiber

Example project go fiber api by EyeOfCode

stack

• docker
• docker-compose
• go fiber
• mongodb
• swagger
• jwt
• air
• rate limit
• websocket
• upload file
• redis
• golangci-lint

setup

• install go and setup path
• install docker and docker-compose

create file .air.toml

root = "."
tmp_dir = "tmp"

[build]
cmd = "go build -o ./tmp/main.exe ./cmd/api"
bin = "tmp/main.exe"
full_bin = "./tmp/main.exe"
include_ext = ["go"]
exclude_dir = ["tmp", "mongodb_data"]
delay = 1000

[screen]
clear_on_rebuild = true

• init project $go mod init example-go-project
• init package $go mod tidy
• cp .env.example .env
• init swagger $swag init -g cmd/api/main.go
• build $go build cmd/api/main.go
• lint $golangci-lint run
• format $gofmt -w .

how to use

• run $docker-compose up -d --build (init project or db)
• run app $go run cmd/api/main.go or use $air (air is build and compiler follow code change)

run test

• $go test ./internal/test
• $go test -race ./internal/test -v -cover
• $go test -race ./internal/test -v -coverprofile=coverage.out && go tool cover -html=coverage.out

Feature

• use swagger [x]
• use ratelimit [x]
• use jwt [x]
• use mongodb [x]
• use auth [x]
• use call external api [x]
• use upload and read file [x]
• use docker [x]
• set pattern code [x]
• unit test [x]
• restful api [x]
• relation db [x]
• permission roles [x]
• pagination [x]
• redis [x]
• refresh token [x]

other

$go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest $go install github.com/cosmtrek/air@latest $go install github.com/swaggo/swag/cmd/swag@latest