😙added: dependabot, docker (dev and prod) and rest.http files

Author: coderj001

cookiecutter.json

@@ -4,9 +4,11 @@
   "docker_hub_username": "coderj001",
   "project_name": "goapis",
   "project_short_description": "A golang api's projects",
+  "project_long_description": "A golang api's projects...",
   "api_version": "v1",
   "use_github_action": "y",
   "use_rest_http": "y",
+  "use_docker": "y",
   "docker_images_name": "goapis",
   "go_version": "1.20",
   "license": ["MIT", "BSD-3", "GNU GPL v3.0", "Apache Software License 2.0"]

hooks/post_gen_project.sh

@@ -1,6 +1,9 @@
 #!/usr/bin/env bash
 
 set -euo pipefail
+red=`tput setaf 1`
+green=`tput setaf 2`
+reset=`tput sgr0`
 IFS=$'\n\t'
 
 #
@@ -15,10 +18,50 @@ function echo_info() {
 # Step 1:
 #
 
+if [[ echo "{{cookiecutter.use_docker}}" | grep -iq "^n" ]]; then
+	rm -rf docker/ compose/
+fi
+
+#
+# Step 2:
+#
+
+if [[ echo "{{cookiecutter.use_rest_http}}" | grep -iq "^n" ]]; then
+	rm -rf rest.txt
+elif
+	echo_info "Install rest.http extension for vscode"
+	mv rest.txt rest.http
+fi
+
+#
+# Step 3:
+#
+
+if [[ echo "{{cookiecutter.use_github_action}}" | grep -iq "^n" ]]; then
+	rm -rf .github/
+fi
+
+#
+# Step 4:
+#
+
+echo_info "Setup env"
+cp env.example
+cp env.example .env
+echo """
+
+# JWT Secret
+JWT_SECRET=$(openssl rand -base64 32)
+""" >> .env
+
+#
+# Step 5:
+#
+
 echo_info "Initializing Git"
 git init
 git add .
-git commit -n -m "Initial Commit"
+git commit -n -m "🔧 chore: initial commit"
 
 #
 # Done:

{{cookiecutter.project_name}}/.github/dependabot.yml

@@ -0,0 +1,14 @@
+version: 2
+updates:
+  - package-ecosystem: "gomod"
+    directory: "/"
+
+    # Auto assign PRs raised to this account on Github
+    assignees:
+      - "{{cookiecutter.github_username}}"
+
+
+    # Check for updates to dependencies once a week - Saturday
+    schedule:
+      interval: "weekly"
+      day: "saturday"

{{cookiecutter.project_name}}/README.md

@@ -1,2 +1,5 @@
 # {{ cookiecutter.project_name|replace('go', '')|upper|replace('-',' ') }}
 
+** {{cookiecutter.project_long_description}} **
+
+

{{cookiecutter.project_name}}/docker/Dockerfile.dev

@@ -0,0 +1,34 @@
+FROM golang:1.20.5-alpine
+
+# Set Working Dir
+WORKDIR /app
+
+# Install nessery dependencies
+RUN apk --no-cache add \
+    ca-certificates \
+    git
+
+# Copy go.mod and go.sum
+COPY go.mod go.sum ./
+
+# Download all dependencies
+RUN go mod download
+
+# Install Air using the recommended install script
+RUN go install github.com/cosmtrek/air@latest
+
+# Verify Air installation
+RUN air -v
+
+# Copy the rest of your application code
+COPY . .
+
+# Expose port 8000
+EXPOSE 8000
+
+# Set the entrypoint to `air`. Note the full path to the air binary.
+ENTRYPOINT ["air", "-c", "air.toml"]
+
+# Health check
+HEALTHCHECK --interval=30s --timeout=3s \
+  CMD wget --quiet --tries=1 --spider http://localhost:8000/health || exit 1

{{cookiecutter.project_name}}/docker/Dockerfile.prod

@@ -0,0 +1,28 @@
+############################
+##     Build Stage        ##
+############################
+FROM golang:alpine AS build-env
+
+RUN apk --no-cache add \
+    ca-certificates \
+    git \
+    build-base 
+
+WORKDIR /app
+
+COPY go.mod go.sum ./
+RUN go mod download
+
+COPY . .
+RUN go build -o {{cookiecutter.project_name}} ./cmd/main.go
+
+############################
+##     Final Stage        ##
+############################
+FROM alpine:latest
+
+WORKDIR /app
+
+COPY --from=build-env /app/{{cookiecutter.project_name}} /app/
+
+ENTRYPOINT ./{{cookiecutter.project_name}}

{{cookiecutter.project_name}}/rest.txt

@@ -0,0 +1,58 @@
+@baseURL = http://localhost:8000
+@token = eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE2ODg1NzgwMzQsImlhdCI6MTY4ODQ5MTYzNH0.03hUcVbQUOn6MX-FoWFcThvPF9PBgozJIhYWc0V9E6Q
+
+### Test API
+GET {{baseURL}}/health
+Content-Type: application/json
+
+### User Register
+POST {{baseURL}}/user/register
+Content-Type: application/json
+
+{
+  "name": "John Doe",
+  "phone": "1234567890",
+  "email": "johndoe@example.com",
+  "password": "password123"
+}
+
+### User Login
+POST {{baseURL}}/user/login
+Content-Type: application/json
+
+{
+  "email": "johndoe@example.com",
+  "password": "password123"
+}
+
+### Create Contact
+POST {{baseURL}}/contact
+Content-Type: application/json
+Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE2ODg4MDA0MTMsImlhdCI6MTY4ODcxNDAxM30.nJhkx4n7VeoyQQ0hax5hsuYFG0Yo6Q4OIN3_cFqIGUw
+
+{
+  "name": "neo ai",
+  "phone_number": "1234567891"
+}
+
+### Mark as spam
+POST {{baseURL}}/spam
+Content-Type: application/json
+
+{
+  "phone_number": "1234567890"
+}
+
+### Search by Name
+GET {{baseURL}}/search?name=neo
+Content-Type: application/json
+Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE2ODg4MDA0MTMsImlhdCI6MTY4ODcxNDAxM30.nJhkx4n7VeoyQQ0hax5hsuYFG0Yo6Q4OIN3_cFqIGUw
+
+### Search by Phone Number
+GET {{baseURL}}/search?phone_number=1234567890
+Content-Type: application/json
+Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE2ODg4MDA0MTMsImlhdCI6MTY4ODcxNDAxM30.nJhkx4n7VeoyQQ0hax5hsuYFG0Yo6Q4OIN3_cFqIGUw
+
+### User Details
+GET {{baseURL}}/user/1
+Content-Type: application/json