Goilerplate

For the perfect structure. 🔥🔥🔥

Contents

• Implemented Features
• Kubernetes
  • api.yml
  • postgres.yml
  • pgadmin4.yml
  • redis.yml
• Quick start
  • Docker-Compose Infra
  • Kubernetes Infra
• Auth API
  • Sign Up
  • Sign In
  • User Info

Implemented Features

• Routing - Gin Web Framework ----------------------------📚 :octocat:

• CLI - Cobra -------------------------------------------------📚 :octocat:

• Dependency Injection - Fx --------------------------------📚 :octocat:

• Environment - Viper ---------------------------------------:octocat:

• Logging - Zap ----------------------------------------------:octocat:

• PostgreSQL - GORM ---------------------------------------📚 :octocat:

• Redis - Go-Redis -------------------------------------------📚 :octocat:

• DB Viewer - pgAdmin4 (Web) -----------------------------🐳

• Authentication - JWT (Access + refresh) ------------------:octocat:

Kubernetes

api.yml

• Deployment
• Service

postgres.yml

• Deployment
• ConfigMap
• Service
• PersistentVolume
• PersistentVolumeClaim

pgadmin4.yml

• Deployment
• ConfigMap
• Service

redis.yml

• Deployment
• Service
• PersistentVolume
• PersistentVolumeClaim

Quick start

Docker-Compose Infra

• Make sure you have docker installed.
• Copy /env/stage.env to .env
• Run docker-compose up -d
  • API Host: localhost:5000
    • [POST] auth/signup
    • [POST] auth/signin
    • [GET] user/info
  • DB Viewer Host: localhost:8080
    • Email: user@goilerplate.com - PW: 1234

Kubernetes Infra

• Make sure you have kubectl(Kubernetes) installed.
• Run kubectl apply -f .\k8s\
  • API Host: localhost:32000
    • [POST] auth/signup
    • [POST] auth/signin
    • [GET] user/info
  • DB Viewer Host: localhost:30080
    • Email: user@goilerplate.com - PW: 1234

Auth API (Postman Tool)

- SignUp

- SignIn

- User Info