Giter VIP home page Giter VIP logo

go-api-template's Introduction

API Server Template


This template is inspired by https://ldej.nl/post/enterprise-go-architecture/

Language, Libraries, and Dependencies

Purpose Name Version License
Language Go 1.18.6 BSD-3
Framework Gin 1.8.1 MIT
Configuration Access Viper 1.13.0 MIT
Mock go-sqlmock 1.5.0 BSD-3
Logging logrus 1.9.0 MIT
ORM GORM 1.23.10 MIT
API Documentation Swag 1.8.6 MIT
Message Queue Go NSQ 1.1.0 MIT

Folder Structure

├── .githooks
├── server
    ├── clients
        ├── microservice-2
    ├── constants
    ├── consumers
    ├── controller
    ├── db
    ├── error
    ├── mocks
    ├── models
        ├── request
        ├── response
    ├── repository
    ├── router
    ├── service
    ├── utils
├── build-scripts
├── config
├── database        // only migrations
├── Dockerfile
├── Dockerfile.debug
├── docs            // swagger
├── infrastructure  // docker
├── go.mod
├── go.sum
├── main.go
├── Makefile
├── README.md
├── sqlite.db
└── template.toml

Steps

  1. Run make init
  2. Copy ./config/template.toml to ./config/server.toml (Do not add server.toml to repository)
  3. Update server.toml values

Commit Message

We follow Conventional Commit's specification for commit messages

go-api-template's People

Contributors

realcoolsnow avatar

Watchers

 avatar  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.