✨ Project template started

Author: Youngermaster

.air.toml

@@ -0,0 +1,67 @@
+# Config file for [Air](https://github.com/cosmtrek/air) in TOML format
+
+# Working directory
+# . or absolute path, please note that the directories following must be under root.
+root = "."
+tmp_dir = "tmp"
+
+[build]
+# Just plain old shell command. You could use `make` as well.
+cmd = "go build -o ./tmp/main ./cmd"
+# Binary file yields from `cmd`.
+bin = "tmp/main"
+# Customize binary, can setup environment variables when run your app.
+full_bin = "APP_ENV=dev APP_USER=air ./tmp/main"
+# Watch these filename extensions.
+include_ext = ["go", "tpl", "tmpl", "html"]
+# Ignore these filename extensions or directories.
+exclude_dir = ["assets", "tmp", "vendor", "frontend/node_modules"]
+# Watch these directories if you specified.
+include_dir = []
+# Watch these files.
+include_file = []
+# Exclude files.
+exclude_file = []
+# Exclude specific regular expressions.
+exclude_regex = ["_test\\.go"]
+# Exclude unchanged files.
+exclude_unchanged = true
+# Follow symlink for directories
+follow_symlink = true
+# This log file places in your tmp_dir.
+log = "air.log"
+# Poll files for changes instead of using fsnotify.
+poll = false
+# Poll interval (defaults to the minimum interval of 500ms).
+poll_interval = 500 # ms
+# It's not necessary to trigger build each time file changes if it's too frequent.
+delay = 0 # ms
+# Stop running old binary when build errors occur.
+stop_on_error = true
+# Send Interrupt signal before killing process (windows does not support this feature)
+send_interrupt = false
+# Delay after sending Interrupt signal
+kill_delay = 500 # ms
+# Rerun binary or not
+rerun = false
+# Delay after each executions
+rerun_delay = 500
+# Add additional arguments when running binary (bin/full_bin). Will run './tmp/main hello world'.
+args_bin = ["hello", "world"]
+
+[log]
+# Show log time
+time = false
+# Only show main log (silences watcher, build, runner)
+main_only = false
+
+[color]
+# Customize each part's color. If no color found, use the raw app log.
+main = "magenta"
+watcher = "cyan"
+build = "yellow"
+runner = "green"
+
+[misc]
+# Delete tmp directory on exit
+clean_on_exit = true

.env.example

@@ -0,0 +1,7 @@
+DB_PORT=5432
+DB_USER=example_user
+DB_PASSWORD=example_password
+DB_NAME=example_db
+SECRET=example_secret
+PGADMIN_DEFAULT_EMAIL=[email protected]
+PGADMIN_DEFAULT_PASSWORD=SecurePassword

.gitignore

@@ -7,6 +7,7 @@
 *.dll
 *.so
 *.dylib
+main
 
 # Test binary, built with `go test -c`
 *.test
@@ -19,3 +20,6 @@
 
 # Go workspace file
 go.work
+
+# Environment variables file
+.env

Dockerfile

@@ -0,0 +1,14 @@
+FROM golang:1.21@sha256:cffaba795c36f07e372c7191b35ceaae114d74c31c3763d442982e3a4df3b39e
+
+# Enviroment variable
+WORKDIR /usr/src/some-api
+
+RUN go install github.com/cosmtrek/air@latest
+
+#Copying files to work directory
+COPY go.mod ./
+RUN go mod download && go mod verify
+COPY . .
+
+# Run and expose the server on port 3000
+EXPOSE 3000

README.md

@@ -0,0 +1,32 @@
+# Go Fiber + JWT Auth + Docker + PostgreSQL Boilerplate
+
+Boilerplate for Go Fiber that makes use of Docker, PostgreSQL and JWT.
+
+## Development
+
+### In order to have an optimal development experience you need to have Docker installed
+
+Set the environment variables in a `.env` file:
+
+- DB_PORT=5432
+- DB_USER=example_user
+- DB_PASSWORD=example_password
+- DB_NAME=example_db
+- SECRET=example_secret
+
+Be sure you don't have any conflicting containers.
+Then run the commands:
+
+```sh
+docker-compose up -d
+```
+
+This should start the API and the database.
+
+## Database Management
+
+You can manage the database via `psql` with the command:
+
+```sh
+docker-compose exec db psql -U <DB_USER (from the environment variables)>
+```

cmd/main.go

@@ -0,0 +1,26 @@
+package main
+
+import (
+	"app/database"
+	"app/router"
+	"log"
+
+	"github.com/gofiber/fiber/v2"
+	// "github.com/gofiber/fiber/v2/middleware/cors"
+)
+
+func main() {
+	app := fiber.New(fiber.Config{
+		Prefork:       true,
+		CaseSensitive: true,
+		StrictRouting: true,
+		ServerHeader:  "Fiber",
+		AppName:       "App Name",
+	})
+	// app.Use(cors.New())
+
+	database.ConnectDB()
+
+	router.SetupRoutes(app)
+	log.Fatal(app.Listen(":3000"))
+}

config/config.go

@@ -0,0 +1,18 @@
+package config
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/joho/godotenv"
+)
+
+// Config func to get env value
+func Config(key string) string {
+	// load .env file
+	err := godotenv.Load(".env")
+	if err != nil {
+		fmt.Print("Error loading .env file")
+	}
+	return os.Getenv(key)
+}

create_user.json

@@ -0,0 +1,5 @@
+{
+  "username": "johndoe",
+  "email": "[email protected]",
+  "password": "1234567890"
+}

database/connect.go

@@ -0,0 +1,39 @@
+package database
+
+import (
+	"app/config"
+	"app/model"
+	"fmt"
+	"strconv"
+
+	"gorm.io/driver/postgres"
+	"gorm.io/gorm"
+)
+
+// ConnectDB connect to db
+func ConnectDB() {
+	var err error
+	p := config.Config("DB_PORT")
+	port, err := strconv.ParseUint(p, 10, 32)
+
+	if err != nil {
+		panic("failed to parse database port")
+	}
+
+	dsn := fmt.Sprintf(
+		"host=db port=%d user=%s password=%s dbname=%s sslmode=disable",
+		port,
+		config.Config("DB_USER"),
+		config.Config("DB_PASSWORD"),
+		config.Config("DB_NAME"),
+	)
+	DB, err = gorm.Open(postgres.Open(dsn), &gorm.Config{})
+
+	if err != nil {
+		panic("failed to connect database")
+	}
+
+	fmt.Println("Connection Opened to Database")
+	DB.AutoMigrate(&model.Product{}, &model.User{})
+	fmt.Println("Database Migrated")
+}

database/database.go

@@ -0,0 +1,6 @@
+package database
+
+import "gorm.io/gorm"
+
+// DB gorm connector
+var DB *gorm.DB

docker-compose.yml

@@ -0,0 +1,38 @@
+version: '3.8'
+services:
+  web:
+    build: .
+    env_file:
+      - .env
+    ports:
+      - 3000:3000
+    volumes:
+      - .:/usr/src/some-api
+    depends_on:
+      - db
+    command: air cmd/main.go -b 0.0.0.0
+
+  db:
+    image: postgres:alpine
+    environment:
+      - POSTGRES_USER=${DB_USER}
+      - POSTGRES_PASSWORD=${DB_PASSWORD}
+      - POSTGRES_DB=${DB_NAME}
+    ports:
+      - ${DB_PORT}:${DB_PORT}
+    volumes:
+      - postgres-db:/var/lib/postgresql/data
+
+  pgadmin:
+    image: dpage/pgadmin4
+    environment:
+      - PGADMIN_DEFAULT_EMAIL=${PGADMIN_DEFAULT_EMAIL}
+      - PGADMIN_DEFAULT_PASSWORD=${PGADMIN_DEFAULT_PASSWORD}
+    ports:
+      - 5050:80
+    depends_on:
+      - db
+    restart: unless-stopped
+
+volumes:
+  postgres-db:

go.mod

@@ -0,0 +1,42 @@
+module app
+
+go 1.20
+
+require (
+	github.com/go-playground/validator/v10 v10.18.0
+	github.com/gofiber/contrib/jwt v1.0.7
+	github.com/gofiber/fiber/v2 v2.52.1
+	github.com/golang-jwt/jwt/v5 v5.2.0
+	github.com/joho/godotenv v1.5.1
+	golang.org/x/crypto v0.21.0
+	gorm.io/driver/postgres v1.5.2
+	gorm.io/gorm v1.25.7
+)
+
+require (
+	github.com/MicahParks/keyfunc/v2 v2.1.0 // indirect
+	github.com/andybalholm/brotli v1.0.5 // indirect
+	github.com/gabriel-vasile/mimetype v1.4.3 // indirect
+	github.com/go-playground/locales v0.14.1 // indirect
+	github.com/go-playground/universal-translator v0.18.1 // indirect
+	github.com/google/uuid v1.5.0 // indirect
+	github.com/jackc/pgpassfile v1.0.0 // indirect
+	github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a // indirect
+	github.com/jackc/pgx/v5 v5.5.4 // indirect
+	github.com/jackc/puddle/v2 v2.2.1 // indirect
+	github.com/jinzhu/inflection v1.0.0 // indirect
+	github.com/jinzhu/now v1.1.5 // indirect
+	github.com/klauspost/compress v1.17.0 // indirect
+	github.com/leodido/go-urn v1.4.0 // indirect
+	github.com/mattn/go-colorable v0.1.13 // indirect
+	github.com/mattn/go-isatty v0.0.20 // indirect
+	github.com/mattn/go-runewidth v0.0.15 // indirect
+	github.com/rivo/uniseg v0.4.4 // indirect
+	github.com/valyala/bytebufferpool v1.0.0 // indirect
+	github.com/valyala/fasthttp v1.51.0 // indirect
+	github.com/valyala/tcplisten v1.0.0 // indirect
+	golang.org/x/net v0.21.0 // indirect
+	golang.org/x/sync v0.1.0 // indirect
+	golang.org/x/sys v0.18.0 // indirect
+	golang.org/x/text v0.14.0 // indirect
+)