GithubHelp home page GithubHelp logo

go-api-boilerplate's Introduction

Go API Boilerplate

Overview

Golang reusable API boilerplate with:

  • Gin
  • GORM
  • Swagger docs
  • Manual migrations
  • Seeders
  • JWT Authentication
  • Account Registration
  • Encrypted passwords
  • Docker

Roadmap

  • Add tests
  • Telemetry

Dependencies

  • Go 1.19
  • Docker
  • Docker Compose

Setup

Copy the file .env.example to .env and fill in the values.

See config/config.go for more details.

Run: go install github.com/swaggo/swag/cmd/[email protected] to install the swagger documentation generator.

Running

make up

Commands

Build

make build

Migrate and seed

./api db setup

OR

./api db migrate
./api db seed

PS: Migrations are automatically run on serve command, but seeding is not.

Serve

./api serve

Credits

I, Elias Feijó, had to create an API for a personal project from scratch, and decided to make it reusable.

I was inspired by some of the code in bancodobrasil repositories, such as featws-api and goauth, some of those I've contributed and even was the solo maintainer. Changed a lot of things, but I'm still grateful for the inspiration.

Hope you enjoy it!

go-api-boilerplate's People

Contributors

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