Git Product home page Git Product logo

go-standard-modular-boilerplate's Introduction

go-standard-modular-boilerplate

Go Standard Modular Boilerplate

Technologies

The various packages used are as follows:

  • Gin Gonic - HTTP handler framework
  • PGX - PostgreSQL database driver
  • Squirrel - SQL query builder
  • Scany - Database scanner helper from data to structs
  • Kin OpenAPI - OpenAPI 3.0 / Swagger specifications generator from code
  • CORS - Gin Gonic CORS middleware
  • Go Dot ENV - Dot ENV vars loader
  • Zap - Logger package

Style Guidelines

This boilerplate follows the idiomatic Go code rules, related references below:

Installation

This boilerplate requires Golang v1.17+ to run.

Clone the repository then change your current directory to the repository

cd go-standard-modular-boilerplate

Copy the example env file and make the required configuration changes in the .env file

cp .env.example .env

Start the REST server.

make rest

Server

Open the development server by navigating to your server address in your preferred browser.

http://localhost:1234

Tools as Dependencies

Go Standard Modular Boilerplate is implementing tools as dependencies with go modules. Instructions on how to use them in the application are linked below.

Tools Repository
Migrate https://github.com/golang-migrate/migrate
SQLC https://github.com/kyleconroy/sqlc

Database Migrations & Seeding

Run database migrations up.

make migrate-up

Run database migrations down.

make migrate-down

go-standard-modular-boilerplate's People

Contributors

cadoween avatar

Watchers

 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.