go-gin-example

(โ˜… 7,197)

An example of gin

  • .gitignore
  • Dockerfile
  • go.mod
  • go.sum
  • LICENSE
  • main.go
  • Makefile
  • README.md
  • README_ZH.md

# Installation Guide

1. Get the code
git clone https://github.com/eddycjy/go-gin-example

Downloads the entire project code from GitHub to your computer.

cd go-gin-example

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
โ”œโ”€โ”€ Dockerfile # Docker build file

Builds a runnable image based on the Dockerfile.

docker build -t go-gin-example .

Builds a runnable image based on the Dockerfile.

docker run -p 8000:8000 go-gin-example

Runs the built image as an actual container.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
go run main.go

Runs the Go program directly without a separate build step.

โœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.

Pulled directly from this repo's README.

4. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make build

Compiles the code based on the generated build configuration to produce an executable.

make tool

Compiles the code based on the generated build configuration to produce an executable.

make lint

Compiles the code based on the generated build configuration to produce an executable.

make clean

Compiles the code based on the generated build configuration to produce an executable.

โœ… If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation