feat: add makefile to simplify setup and replace init-env.js script

Author: jomunker

.development.docker-compose.yml

@@ -1,7 +1,7 @@
 version: "3"
 services:
   web:
-    container_name: app
+    container_name: web
     env_file:
       - web/.env
     environment:

cms/init-env.js

@@ -7,8 +7,7 @@
     "develop": "strapi develop",
     "start": "strapi start",
     "build": "strapi build",
-    "strapi": "strapi",
-    "init-env": "node init-env.js"
+    "strapi": "strapi"
   },
   "dependencies": {
     "@strapi/plugin-i18n": "4.14.5",

cms/package.json

@@ -0,0 +1,92 @@
+.PHONY: clean build run logsmake
+
+DC=docker compose -f .development.docker-compose.yml
+
+default: help
+init: init-env check-env install
+
+help:
+	@echo "USAGE:"
+	@echo "  make [TARGET]"
+	@echo
+	@echo "EXAMPLES:"
+	@echo "  Build and start stack for local development with logs:"
+	@echo "    make build dev logs"
+	@echo
+	@echo "TARGETS:"
+	@echo "  init:                                initialize project"
+	@echo
+	@echo "  // For local development"
+	@echo "  dev:                                 start local development"
+	@echo "   dev-all:                            start all dev containers"
+	@echo "   dev-web:                            start dev web image"
+	@echo "   dev-cms:                            start dev cms image"
+	@echo "   dev-db:                             start dev db image"
+	@echo
+	@echo "  // For building containers"
+	@echo "  build:                               build all"
+	@echo "   build-web:                          build web image"
+	@echo "   build-cms:                          build cms image"
+	@echo
+	@echo "  // Utilities"
+	@echo "  install:                             install dependencies for all services"
+	@echo "  init-env:                            initialize .env files"
+	@echo "  check-env:                           compare keys in .env files with .env.example files"
+	@echo "  logs:                                show logs for all containers"
+	@echo "  clean:                               clean up workspace"
+	@echo "  stop:                                stop all containers"
+
+## GENERAL
+
+install:
+	@echo "Installing web dependencies"
+	@cd web && npm install
+	@echo "Installing cms dependencies"
+	@cd cms && npm install
+
+init-env:
+	test -f .env || cp .env.example .env
+	test -f web/.env || cp .env.example web/.env
+	cd cms/ && ( test -f .env || cp .env.example .env )
+	@echo '-----------------------------------------------------'
+	@echo 'please update the .env files with the missing secrets'
+
+check-env:
+	./scripts/check-env.sh .env.example .env
+	./scripts/check-env.sh .env.example web/.env
+	./scripts/check-env.sh cms/.env.example cms/.env
+
+logs:
+	$(DC) logs -t -f web db cms
+
+clean:
+	$(DC) down
+	$(DC) down --volumes
+
+stop:
+	$(DC) stop
+
+## DOCKER DEVELOPMENT
+dev: init dev-all
+
+dev-all:
+	$(DC) up -d
+
+dev-web:
+	$(DC) up -d web
+
+dev-cms:
+	$(DC) up -d cms
+
+dev-database:
+	$(DC) up -d db
+
+## DOCKER BUILD
+build: init
+	$(DC) build
+
+build-web:
+	$(DC) build web
+
+build-backend:
+	$(DC) build cms

makefile

@@ -4,7 +4,6 @@
   "description": "Next generation of Vim Landing Page",
   "scripts": {
     "dev": "docker compose -f .development.docker-compose.yml up -d --build",
-    "setup": "node ./cms/init-env.js"
   },
   "author": "",
   "license": "ISC"

package.json

@@ -0,0 +1,25 @@
+#!/bin/sh
+
+# USAGE: compare two .env files and check if keys are missing in the first.
+#        keys are in the format of "KEY=VALUE"
+#
+#   ARG 1: file which contains required keys
+#   ARG 2: file to check for missing keys
+
+die() {
+    echo "error: $*"
+    exit 1
+}
+
+file="$1"
+ref_file="$2"
+
+[ -f "$file" ] || die "missing arg: .env file to compare"
+[ -f "$ref_file" ] || die "missing arg: reference .env file"
+
+echo "comparing '$file' to '$ref_file'"
+grep  -v "^#" "$file" |
+    while read -r line; do
+        key=$(echo "$line" | cut -d'=' -f 1)
+        grep -q "$key" "$ref_file" || die "key '$key' missing in '$ref_file'"
+    done