Initial commit

koddr · koddr · commit d29df0b20557 · 2022-01-05T18:07:21.000+03:00
diff --git a/.dockerignore b/.dockerignore
@@ -0,0 +1,19 @@
+# Files
+.dockerignore
+.editorconfig
+.gitignore
+.env.*
+Dockerfile
+Makefile
+LICENSE
+**/*.md
+**/*_test.go
+*.out
+*.http
+
+# Folders
+.vscode/
+.idea/
+.git/
+.github/
+build/
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,16 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[{go.mod,go.sum,*.go}]
+indent_style = tab
+indent_size = 4
+
+[{Makefile,Dockerfile,*.yml,*.yaml}]
+indent_style = tab
+indent_size = 2
diff --git a/.env.example b/.env.example
@@ -0,0 +1,11 @@
+# Stage status to start server:
+#   - "dev", for start server without graceful shutdown
+#   - "prod", for start server with graceful shutdown
+STAGE_STATUS="dev"
+
+# Server settings:
+SERVER_HOST="0.0.0.0"
+SERVER_PORT=5000
+SERVER_READ_TIMEOUT=5
+SERVER_WRITE_TIMEOUT=10
+SERVER_IDLE_TIMEOUT=120
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1 @@
+go.sum merge=union
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,17 @@
+# macOS
+**/.DS_Store
+
+# IDE
+.vscode/
+.idea/
+
+# Dev build
+build/
+tmp/
+
+# Test
+*.out
+*.http
+
+# Environment variables
+.env
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,25 @@
+FROM golang:1.17-alpine AS builder
+
+LABEL maintainer="Vic Shóstak <vic@shostak.dev> (https://shostak.dev/)"
+
+# Move to working directory (/build).
+WORKDIR /build
+
+# Copy and download dependency using go mod.
+COPY go.mod go.sum ./
+RUN go mod download
+
+# Copy the code into the container.
+COPY . .
+
+# Set necessary environment variables needed for our image and build the API server.
+ENV CGO_ENABLED=0 GOOS=linux GOARCH=amd64
+RUN go build -ldflags="-s -w" -o apiserver .
+
+FROM scratch
+
+# Copy binary and config files from /build to root folder of scratch container.
+COPY --from=builder ["/build/apiserver", "/build/.env", "/"]
+
+# Command to run when starting the container.
+ENTRYPOINT ["/apiserver"]
diff --git a/LICENSE b/LICENSE
@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2021 Vic Shóstak and Create Go App Contributors
+   Copyright 2022 Vic Shóstak and Create Go App Contributors
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
diff --git a/Makefile b/Makefile
@@ -0,0 +1,47 @@
+.PHONY: clean critic security lint test build run
+
+APP_NAME = apiserver
+BUILD_DIR = $(PWD)/build
+
+clean:
+	rm -rf ./build
+
+critic:
+	gocritic check -enableAll ./...
+
+security:
+	gosec ./...
+
+lint:
+	golangci-lint run ./...
+
+test: clean critic security lint
+	go test -v -timeout 30s -coverprofile=cover.out -cover ./...
+	go tool cover -func=cover.out
+
+build: test
+	CGO_ENABLED=0 go build -ldflags="-w -s" -o $(BUILD_DIR)/$(APP_NAME) main.go
+
+run: build
+	$(BUILD_DIR)/$(APP_NAME)
+
+docker.run: docker.network docker.chi
+
+docker.network:
+	docker network inspect dev-network >/dev/null 2>&1 || \
+	docker network create -d bridge dev-network
+
+docker.chi.build:
+	docker build -t chi .
+
+docker.chi: docker.chi.build
+	docker run --rm -d \
+		--name cgapp-chi \
+		--network dev-network \
+		-p 5000:5000 \
+		chi
+
+docker.stop: docker.stop.chi
+
+docker.stop.chi:
+	docker stop cgapp-chi
diff --git a/README.md b/README.md
@@ -1,2 +1,63 @@
-# chi-go-template
-📝 [WIP] Chi backend template for Create Go App CLI.
+# go-chi backend template for [Create Go App CLI](https://github.com/create-go-app/cli)
+
+<img src="https://img.shields.io/badge/Go-1.17+-00ADD8?style=for-the-badge&logo=go" alt="go version" />
+&nbsp;<a href="https://goreportcard.com/report/github.com/create-go-app/fiber-go-template" target="_blank"><img src="https://img.shields.io/badge/Go_report-A+-success?style=for-the-badge&logo=none" alt="go report" /></a>
+&nbsp;<img src="https://img.shields.io/badge/license-Apache_2.0-red?style=for-the-badge&logo=none" alt="license" />
+
+[chi](https://go-chi.io/#/) iis a lightweight, idiomatic and composable router for building Go HTTP services.
+
+## ⚡️ Quick start
+
+1. Create a new project with Fiber:
+
+```bash
+cgapp create
+
+# Choose a backend framework:
+#   net/http
+#   fiber
+# > go-chi
+```
+
+2. Rename `.env.example` to `.env` and fill it with your environment values.
+3. Install [Docker](https://www.docker.com/get-started) and the following useful Go tools to your system:
+
+- [golang-migrate/migrate](https://github.com/golang-migrate/migrate#cli-usage) for apply migrations
+- [github.com/securego/gosec](https://github.com/securego/gosec) for checking Go security issues
+- [github.com/go-critic/go-critic](https://github.com/go-critic/go-critic) for checking Go the best practice issues
+- [github.com/golangci/golangci-lint](https://github.com/golangci/golangci-lint) for checking Go linter issues
+
+4. Run project by this command:
+
+```bash
+make docker.run
+```
+
+## 📦 Used packages
+
+| Name                                                                  | Version  | Type       |
+|-----------------------------------------------------------------------| -------- | ---------- |
+| [go-chi/chi](https://github.com/go-chi/chi)                           | `v5.0.7` | core       |
+| [joho/godotenv](https://github.com/joho/godotenv)                     | `v1.4.0` | config     |
+
+## ⚙️ Configuration
+
+```ini
+# .env
+
+# Stage status to start server:
+#   - "dev", for start server without graceful shutdown
+#   - "prod", for start server with graceful shutdown
+STAGE_STATUS="dev"
+
+# Server settings:
+SERVER_HOST="0.0.0.0"
+SERVER_PORT=5000
+SERVER_READ_TIMEOUT=5
+SERVER_WRITE_TIMEOUT=10
+SERVER_IDLE_TIMEOUT=120
+```
+
+## ⚠️ License
+
+Apache 2.0 &copy; [Vic Shóstak](https://shostak.dev/) & [True web artisans](https://1wa.co/).
diff --git a/api_test.http b/api_test.http
@@ -0,0 +1,3 @@
+GET http://localhost:5000/hc/status
+
+###
diff --git a/cmd/run.go b/cmd/run.go
@@ -0,0 +1,25 @@
+package cmd
+
+import (
+	"net/http"
+
+	"github.com/go-chi/chi/v5"
+
+	"github.com/create-go-app/chi-go-template/internal/config"
+)
+
+// Run function to start server instance with config & router.
+func Run(c *config.Config, r *chi.Mux) error {
+	// Prepare server with CloudFlare recommendation timeouts config.
+	// See: https://blog.cloudflare.com/the-complete-guide-to-golang-net-http-timeouts/
+	server := &http.Server{
+		Handler:      r,
+		Addr:         c.Server.Addr,
+		ReadTimeout:  c.Server.ReadTimeout,
+		WriteTimeout: c.Server.WriteTimeout,
+		IdleTimeout:  c.Server.IdleTimeout,
+	}
+
+	// Start server.
+	return server.ListenAndServe()
+}
diff --git a/go.mod b/go.mod
@@ -0,0 +1,8 @@
+module github.com/create-go-app/chi-go-template
+
+go 1.17
+
+require (
+	github.com/go-chi/chi/v5 v5.0.7
+	github.com/joho/godotenv v1.4.0
+)
diff --git a/go.sum b/go.sum
@@ -0,0 +1,4 @@
+github.com/go-chi/chi/v5 v5.0.7 h1:rDTPXLDHGATaeHvVlLcR4Qe0zftYethFucbjVQ1PxU8=
+github.com/go-chi/chi/v5 v5.0.7/go.mod h1:DslCQbL2OYiznFReuXYUmQ2hGd1aDpCnlMNITLSKoi8=
+github.com/joho/godotenv v1.4.0 h1:3l4+N6zfMWnkbPEXKng2o2/MR5mSwTrBih4ZEkkz1lg=
+github.com/joho/godotenv v1.4.0/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4=
diff --git a/internal/config/config.go b/internal/config/config.go
@@ -0,0 +1,68 @@
+package config
+
+import (
+	"fmt"
+	"os"
+	"strconv"
+	"sync"
+	"time"
+)
+
+// Config struct for describe configuration of the app.
+type Config struct {
+	Server *serverConfig
+}
+
+type serverConfig struct {
+	Addr         string
+	ReadTimeout  time.Duration
+	WriteTimeout time.Duration
+	IdleTimeout  time.Duration
+}
+
+var (
+	once     sync.Once // create sync.Once primitive
+	instance *Config   // create nil Config struct
+)
+
+// NewConfig function to prepare config variables from .env file and return config.
+func NewConfig() *Config {
+	// Configuring config one time.
+	once.Do(func() {
+		// Server host (should be string):
+		host := os.Getenv("SERVER_HOST")
+		// Server port (should be int):
+		port, err := strconv.Atoi(os.Getenv("SERVER_PORT"))
+		if err != nil {
+			panic("wrong server port (check your .env)")
+		}
+		// Server read timeout (should be int):
+		readTimeout, err := strconv.Atoi(os.Getenv("SERVER_READ_TIMEOUT"))
+		if err != nil {
+			panic("wrong server read timeout (check your .env)")
+		}
+		// Server write timeout (should be int):
+		writeTimeout, err := strconv.Atoi(os.Getenv("SERVER_WRITE_TIMEOUT"))
+		if err != nil {
+			panic("wrong server write timeout (check your .env)")
+		}
+		// Server idle timeout (should be int):
+		idleTimeout, err := strconv.Atoi(os.Getenv("SERVER_IDLE_TIMEOUT"))
+		if err != nil {
+			panic("wrong server idle timeout (check your .env)")
+		}
+
+		// Set all variables to the config instance.
+		instance = &Config{
+			Server: &serverConfig{
+				Addr:         fmt.Sprintf("%s:%d", host, port),
+				ReadTimeout:  time.Duration(readTimeout) * time.Second,
+				WriteTimeout: time.Duration(writeTimeout) * time.Second,
+				IdleTimeout:  time.Duration(idleTimeout) * time.Second,
+			},
+		}
+	})
+
+	// Return configured config instance.
+	return instance
+}
diff --git a/internal/router/healthcheck/handlers.go b/internal/router/healthcheck/handlers.go
@@ -0,0 +1,7 @@
+package healthcheck
+
+import "net/http"
+
+func getStatus(w http.ResponseWriter, _ *http.Request) {
+	w.WriteHeader(http.StatusOK)
+}
diff --git a/internal/router/healthcheck/routes.go b/internal/router/healthcheck/routes.go
@@ -0,0 +1,16 @@
+package healthcheck
+
+import "github.com/go-chi/chi/v5"
+
+const (
+	groupURL  = "/hc"
+	statusURL = "/status"
+)
+
+// Routes function to create router.
+func Routes(m *chi.Mux) {
+	// Create group.
+	m.Route(groupURL, func(r chi.Router) {
+		r.Get(statusURL, getStatus) // get status route
+	})
+}
diff --git a/internal/router/router.go b/internal/router/router.go
@@ -0,0 +1,15 @@
+package router
+
+import (
+	"net/http"
+
+	"github.com/go-chi/chi/v5"
+
+	"github.com/create-go-app/chi-go-template/internal/router/healthcheck"
+)
+
+// GetRoutes function for getting routes.
+func GetRoutes(m *chi.Mux) {
+	healthcheck.Routes(m)     // health check routes
+	m.NotFound(http.NotFound) // not found routes
+}
diff --git a/main.go b/main.go

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+GET http://localhost:5000/hc/status`
	`2`	`+`
	`3`	`+###`