Go Clean Architecture

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Deployment

About The Project

This API is for Simple Demo Clean Architecture in Golang application.

Built With

(back to top)

Getting Started

Prerequisites

1. Install go. You can download the Golang in this page. You should install version 1.20
2. Install Postgres database. You can download the Postgres in this page. You should install version 14.1

Installation

Via go

1. You run this command to install packages

   go mod download

2. Create .env file from .env.example file.
3. You run this command to start

   go run app/entry/api/main.go

4. You run this command to start

   curl --location 'http://localhost:9999/api/v1/migrate' \
   --header 'Content-Type: application/x-www-form-urlencoded' \
   --data-urlencode 'key=yourkeyhere'
   

5. You run this command to start

   curl --location 'http://localhost:9999/api/v1/user' \
   --header 'Content-Type: application/json' \
   --data '{
       "user_name": "yourusername"
   }'
   

Via docker

1. Run by docker

   docker-compose up

2. Then you can do from step 4 of Run via Go