Code Monkey home page Code Monkey logo

go-boilerplate's Introduction

go-boilerplate

Golang API Service boilerplate using best practices of Clean Architecture.

Responsibility: CRUD and Login Users with JWT.

Dependencies

  • Gin-Gonic
  • Swaggo
  • go-redis
  • GORM (MySQL)
  • Snowflake
  • OpenTelemetry
  • JWT-Go
  • Crypto

Documentation & Routes

Swagger http://localhost:8000/auth/swagger/index.html

Print of Swagger

Jaeger UI http://0.0.0.0:16686/search

Print of Jaeger

On Error Print of Jaeger

SQL Print of Jaeger

Compose Stack

  • API REST
  • MySQL
  • Redis
  • Jaeger

Execution / Compilation

Set Env. variables of .env-sample:

Compile with:

make run

Update Swagger Doc:

make doc

Tests

make test

Path's Organization

Clean Arch Clean Representation

  • assets: static files
  • cmd: binaries entrypoint
  • internal: private packages
    • configs: env. variables
    • usecase: business logical/rules
    • delivery: delivery layer -> http, grpc, messaging
    • entity: entities / schemas
    • repository: storage operations, database interface
    • service: external services call's
  • pkg: public packages
  • docs: Swagger Documentation

go-boilerplate's People

Contributors

felipeagger avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.