GO Template

Table of Contents

• GO Template
  • Tech Stack
  • Getting Started
    • Prerequisites
    • Installation
  • Local Development
  • Folder Structure

Tech Stack

This Go template leverages the following technologies and tools:

• Version: Go v1.20.
• Framework: Echo v4.11.
• Database: PostgreSQL v15.
• Dependencies: golang-jwt/jwt v3.2.2, google/uuid v1.6.0, jmoiron/sqlx v1.3.5, lib/pq v1.10.9

Getting Started

To get started this go template, follow the instructions below.

Prerequisites

• GO: Programming language.
• Download and install PostgreSQL.
  • Create a database for your project and update the configuration accordingly.
• Postman: Install Postman for API testing.

Installation

1. Clone the repository

   git clone https://github.com/GeraAnggaraPutra/blueprint-go

Local Development

1. Navigate to the project directory

   cd your-go-template-directory

2. Copy the .env.example file to .env and update the configurations with your local settings.

   cp .env.example .env

3. Install the project dependencies

   go mod tidy

4. Run the application

   go run cmd/server.go

Folder Structure

blueprint-go/
|-- cmd/
|-- config/
|-- constant/
|-- database/
|   |-- migrations/
|-- helpers/
|-- src/
|   |-- api/
|   |-- domain/
|       |-- feature/
|           |-- controller/
|           |-- payload/
|           |-- repository/
|               |-- dto/
|               |-- model/
|               |-- query/
|           |-- routes/
|           |-- service/
|   |-- handler/
|   |-- middleware/
|   |-- module/
|   |-- public/
|-- .env
|-- .gitignore
|-- .golangci.yaml
|-- go.mod
|-- go.sum
|-- README.md