New structure

Author: Vic Shóstak

.env.example

@@ -0,0 +1,18 @@
+# Server settings:
+SERVER_URL="0.0.0.0:5000"
+SERVER_EMAIL="[email protected]"
+SERVER_EMAIL_PASSWORD="secret"
+
+# JWT settings:
+JWT_SECRET_KEY="secret"
+JWT_REFRESH_KEY="refresh"
+
+# Database settings:
+DB_SERVER_URL="host=localhost port=5432 user=postgres password=password dbname=postgres sslmode=disable"
+DB_MAX_CONNECTIONS=100
+DB_MAX_IDLE_CONNECTIONS=10
+DB_MAX_LIFETIME_CONNECTIONS=2
+
+# SMTP severs settings:
+SMTP_SERVER="smtp.example.com"
+SMTP_PORT=25

.gitignore

@@ -1,19 +1,13 @@
 # macOS
 **/.DS_Store
 
-# Binaries for programs and plugins
-**/*.exe
-**/*.exe~
-**/*.dll
-**/*.so
-**/*.dylib
+# Dev build
+build/
+tmp/
 
-# Test binary, built with `go test -c`
-**/*.test
+# Test
+*.out
+*.test
 
-# Dev Build
-**/app/
-**/build/
-
-# Taskfile
-.task/
+# Environment variables
+.env

Dockerfile

@@ -1,4 +1,4 @@
-FROM golang:1.14-alpine AS builder
+FROM golang:1.16-alpine AS builder
 
 # Move to working directory (/build).
 WORKDIR /build
@@ -10,18 +10,18 @@ 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 GO111MODULE=on CGO_ENABLED=0 GOOS=linux GOARCH=amd64
-RUN go build -ldflags="-w -s" -o apiserver .
+# Set necessary environmet 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/configs/apiserver.yml", "/"]
+COPY --from=builder ["/build/apiserver", "/build/.env", "/"]
 
 # Export necessary port.
 EXPOSE 5000
 
 # Command to run when starting the container.
-ENV CONFIG_PATH=/apiserver.yml
-ENTRYPOINT ["/apiserver"]
+ENV CONFIG_PATH=/.env
+ENTRYPOINT ["/apiserver"]

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Vic Shóstak <[email protected]> (https://1wa.co)
+Copyright (c) 2021 Vic Shóstak <[email protected]> (https://1wa.co)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -1,19 +1,57 @@
 .PHONY: clean test security build run
 
-BUILD_DIR = $(PWD)/build
 APP_NAME = apiserver
+BUILD_DIR = $(PWD)/build
+MIGRATIONS_FOLDER = $(PWD)/platform/migrations
+DATABASE_URL = postgres://$(user):$(pass)@$(host)/$(table)?sslmode=disable
 
 clean:
 	rm -rf ./build
 
-test:
-	go test -cover ./...
-
 security:
 	gosec -quiet ./...
 
-build: security test
+test: security
+	go test -cover ./...
+
+build: clean test
 	CGO_ENABLED=0 go build -ldflags="-w -s" -o $(BUILD_DIR)/$(APP_NAME) main.go
 
-run: clean build
+run: swag.init build
 	$(BUILD_DIR)/$(APP_NAME)
+
+migrate.up:
+	migrate -path $(MIGRATIONS_FOLDER) -database "$(DATABASE_URL)" up
+
+migrate.down:
+	migrate -path $(MIGRATIONS_FOLDER) -database "$(DATABASE_URL)" down
+
+migrate.force:
+	migrate -path $(MIGRATIONS_FOLDER) -database "$(DATABASE_URL)" force $(version)
+
+docker.build:
+	docker build -t fiber-go-template .
+
+docker.run: docker.net_http docker.postgres
+
+docker.stop:
+	docker stop dev-net_http dev-postgres
+
+docker.net_http:
+	docker run --rm -d \
+		--name dev-net_http \
+		--network dev-network \
+		-p 5000:5000 \
+		net_http-go-template
+
+docker.postgres:
+	docker run --rm -d \
+		--name dev-postgres \
+		--network dev-network \
+		-e POSTGRES_PASSWORD=password \
+		-v ${HOME}/dev-postgres/data/:/var/lib/postgresql/data \
+		-p 5432:5432 \
+		postgres
+
+swag.init:
+	swag init

app/BUSINESS_LOGIC.md

@@ -0,0 +1,8 @@
+# ./app
+
+**Folder with business logic only**. This directory doesn't care about _what database driver you're using_ or _which caching solution your choose_ or any third-party things.
+
+- `./app/controllers` folder for functional controllers (used in routes)
+- `./app/models` folder for describe business models of your project
+- `./app/queries` folder for describe queries for models of your project
+- `./app/validators` folder for describe validators for models fields