go-microservice

command module
v0.0.0-...-3db5634 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 30, 2024 License: MIT Imports: 14 Imported by: 0

README

go-microservice

Golang archetype oriented to microservices.

Dependencies

Golang, Docker, Make, Swag tool

Features

  • Architecture
    • Handlers, respositories and services
    • Custom Messages and Errors
    • Pagination and Ordering
    • DB Migrator
  • Go 1.23 (at the moment)
  • Libraries
    • Web: Fiber
    • ORM: Gorm
    • OAuth2: Gocloak
    • Validations: Go Playground Validator
    • Unit Test: Testify
    • DB: Postgres
    • Tracing: Opentelemetry
    • Test: Testcontainers
    • OpenAPI: Fiber Swagger
  • Keycloak as Auth Server
  • Distributed tracing
    • OpenTelemetry, Micrometer and Jaeger
  • Swagger
    • Swaggo & Fiber Swagger
    • Customized with command make swagger (OAuth2 server by parameter and not static)
  • Auditory
    • Gorm custom auditory
  • Database
    • Postgres for the app
    • Testcontainers for testing

Files

Usage

  • Executing make help all the available commands will be listed.
  • Also the standard Go commands could be used, like go run main.go
  • To use this archetype with a different name, execute this command to replace the names:
find . -type f -exec sed -i 's/go-microservice/your-project-name/g' {} +

MongoDB instead of Postgres


Donate
  • Bitcoin (QR) 1GqdJ63RDPE4eJKujHi166FAyigvHu5R7v
  • Paypal

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
api
Package docs Code generated by swaggo/swag.
Package docs Code generated by swaggo/swag.
cmd
domain
internal
tests

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL