Renco Boilerplate

Getting started

This is built on top of Go Echo Golang Framework.

Dependencies

There is some dependencies that we used in this skeleton:

• Go Echo [Go Framework]
• Viper [Go Configuration]
• Cobra [Go Modern CLI]
• Logrus Logger [Go Logger]
• Goose Migration [Go Migration]
• OpenTelemetry [OpenTelemetry Tracer] - Upcoming

Requirement

• Golang version 1.23 or latest
• Database PostgreSQL
• Firebase Auth

Usage

Installation

install required dependencies

make install

Run Service

run current service after all dependencies installed

make start-http

Build Service

run this command to build service to binary

make build

run to start service from binary of application

make run-http

Database Migration Management

This document provides instructions for managing database migrations using the provided Makefile. The Makefile includes commands for various migration operations, including applying migrations, rolling them back, and creating new migrations.

Migration Commands

Show Help

make help

Migrate Up

Apply all pending migrations to the database.

make migrate-up

Create Migration

make migrate-create NAME=<migration_name> [TYPE=sql]

# example : make migrate-create NAME=users TYPE=sql

Health Check Endpoint

Go to Endpoint

{base_url}/up

Expected Response:

{
  "ref_id": "z0LMVDmRkV",
  "code": 200,
  "status": "OK",
  "data": {
    "message": "Waras!"
  },
  "timestamp": "2024-09-19T15:31:20.009226+07:00"
}