Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/piinalpin/learn-golang
Repository for learn golang and build into container images
https://github.com/piinalpin/learn-golang
docker gin go golang gorm podman
Last synced: 24 days ago
JSON representation
Repository for learn golang and build into container images
- Host: GitHub
- URL: https://github.com/piinalpin/learn-golang
- Owner: piinalpin
- Created: 2022-06-02T04:06:44.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-07-21T13:59:43.000Z (over 2 years ago)
- Last Synced: 2024-10-15T07:04:36.981Z (2 months ago)
- Topics: docker, gin, go, golang, gorm, podman
- Language: Go
- Homepage: https://sewa-space.herokuapp.com
- Size: 90.8 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Sewa Space App - Learn Golang
## Overview
This project is documentation of my learning Golang with the best practice based on [Standard Go Project Layout](https://github.com/golang-standards/project-layout/), by Kyle Quest.
## Features
- [Gin Web Framework](https://gin-gonic.com/)
- [GORM](https://gorm.io/index.html) MySQL Database Driver
- Custom Soft Deleted
- `CreatedAt`
- `CreatedBy`
- `UpdatedAt`
- `DeletedAt`
- Base Api Response
```json
{
"timestamp": "",
"response_key": "",
"message": "",
"data": {}
}
```
- Custom Exception and Exception Handler
- [Golang Enumerations](https://levelup.gitconnected.com/implementing-enums-in-golang-9537c433d6e2)
- [Golang Generic](https://go.dev/doc/tutorial/generics)
- [Package Validator](https://pkg.go.dev/github.com/go-playground/validator/v10)
- [Logrus](https://pkg.go.dev/github.com/sirupsen/logrus)
- Containerized Support
- Read Environment Variables
- [Json Web Token](https://pkg.go.dev/github.com/golang-jwt/jwt/v4)
- [Redis client for Go](https://github.com/go-redis/redis)
- Custom `TypeConverter` like `ModelMapper` in Spring Boot
- [Gin-Contrib CORS Filter](https://github.com/gin-contrib/cors)
- Role Based Access Control
## Usage
I use `Makefile` to simplify command line usage. Change line before build the application. Change binary filename according target operating system and target architecture.
```Makefile
BIN := goapp.exe
VERSION := 1.0.0
TARGET_OS := windows
TARGET_ARCH := amd64
```
|TARGET OS|TARGET ARCH|
|---|---|
|android|arm|
|linux|amd64|
|linux|arm|
|linux|arm64|
|linux|386|
|windows|amd64|
|windows|386|
|darwin|amd64|
|darwin|arm64|
|etc.|etc.|
The command is :
- `make build` to build binary file
- `make clean` to clean package and remove binary file
- `make docker` it will execute command `clean` and `build` and then build image with `docker` command
- `make podman` it will execute command `clean` and `build` and then build image with `podman` command
**Note :** Run your MySQL Database and Redis Server first before running the application
Run application directly
```bash
go run main.go
```
## Work with containerize
### Build binary and images
```bash
CGO_ENABLED=0 go build -o bin/goapp
docker build -t goapp:latest . -f build/Dockerfile
```
### Run container using Docker
```bash
docker run -d --name goapp -p 8080:8080 --env-file=dev.env --network my-network goapp
```
### Run container using Podman (Arch Linux)
Install `dnsmasq` and `cni-plugins` using package manager
```bash
sudo pacman -S dnsmasq cni-plugins
```
Looking for `cni` binary installed.
```bash
ls -l /opt/cni/bin
ls -l /usr/lib/cni
```
Using git, clone `https://github.com/containers/dnsname.git` see [README_PODMAN.md](https://github.com/containers/dnsname/blob/main/README_PODMAN.md) and change line at `Makefile`
```bash
...
LIBEXECDIR ?= ${PREFIX}/cni/bin
...
```
Install with command `sudo make install PREFIX=/opt`
Change line again at `Makefile`
```bash
...
LIBEXECDIR ?= ${PREFIX}/lib/cni
...
```
Install with command `sudo make install PREFIX=/usr`
Enable `cni` in `/etc/containers/containers.conf`.
```bash
...
cni_plugin_dirs = [
"/usr/local/libexec/cni",
"/usr/libexec/cni",
"/usr/local/lib/cni",
"/usr/lib/cni",
"/opt/cni/bin",
]
...
```
Create new network `podman network create my-network`
Update configuration `my-network` at `$HOME/.config/cni/net.d/my-network.conflist`
```bash
{
"cniVersion": "0.4.0",
"name": "my-network",
"plugins": [
...
{
"type": "dnsname",
"domainName": "my-network",
"capabilities": {
"aliases": true
}
}
...
]
}
```
Run container application
```bash
podman run -d --name goapp -p 8080:8080 --env-file=dev.env --network my-network goapp
```
## Reference
- [Dasar Pemrograman Golang](https://dasarpemrogramangolang.novalagung.com/)
- [Golang: gorm with MySQL and gin](https://blog.canopas.com/golang-gorm-with-mysql-and-gin-ab876f406244)
- [Using JWT for Authentication in a Golang Application](https://codeburst.io/using-jwt-for-authentication-in-a-golang-application-e0357d579ce2)
- [Preloading (Eager Loading)](https://gorm.io/docs/preload.html)
- [How to parse JSON string to struct](https://stackoverflow.com/questions/47270595/how-to-parse-json-string-to-struct)
- [Golang : Is conversion between different struct types possible?](https://stackoverflow.com/questions/24613271/golang-is-conversion-between-different-struct-types-possible)
- [Go Release Binaries](https://github.com/marketplace/actions/go-release-binaries)