justfile docs + refactor

Author: pythoninthegrass

justfile

@@ -6,7 +6,7 @@ set dotenv-load
 # set env var
 export APP      := "compose_image_name"
 export CPU      := "2"
-export IMAGE    := `echo ${REGISTRY_URL}/it
+export IMAGE    := `echo ${REGISTRY_URL}`
 export MEM      := "2048"
 export NS       := "default"
 export PROF     := "minikube"
@@ -47,14 +47,13 @@ build:
 	echo "building ${APP_NAME}:${TAG}"
 
 	if [[ {{arch}} == "arm64" ]]; then
-		docker build -f Dockerfile -t it/${APP_NAME}:${TAG} --build-arg CHIPSET_ARCH=aarch64-linux-gnu .
+		docker build -f Dockerfile -t ${APP_NAME}:${TAG} --build-arg CHIPSET_ARCH=aarch64-linux-gnu .
 	else
-		docker build -f Dockerfile -t it/${APP_NAME}:${TAG} --build-arg CHIPSET_ARCH=x86_64-linux-gnu .
+		docker build -f Dockerfile -t ${APP_NAME}:${TAG} --build-arg CHIPSET_ARCH=x86_64-linux-gnu .
 	fi
 
-	echo "created tag it/${APP_NAME}:${TAG} {{IMAGE}}/${APP_NAME}:${TAG}"
+	echo "created tag ${APP_NAME}:${TAG} {{IMAGE}}/${APP_NAME}:${TAG}"
 
-# TODO: QA
 # [docker] intel build
 buildx:
 	docker buildx build -f Dockerfile --progress=plain -t ${TAG} --build-arg CHIPSET_ARCH=x86_64-linux-gnu --load .
@@ -87,7 +86,7 @@ release:
 	docker push {{IMAGE}}/${APP_NAME}:${TAG}
 
 # [docker] start docker-compose container
-start:
+up:
     docker-compose up -d
 
 # [docker] ssh into container
@@ -104,11 +103,10 @@ down: stop
 
 # [docker] tag image as latest
 tag-latest:
-	@echo "create tag it/${APP_NAME}:${TAG} {{IMAGE}}/${APP_NAME}:${TAG}"
-	docker tag it/${APP_NAME}:${TAG} {{IMAGE}}/${APP_NAME}:${TAG}
+	@echo "create tag ${APP_NAME}:${TAG} {{IMAGE}}/${APP_NAME}:${TAG}"
+	docker tag ${APP_NAME}:${TAG} {{IMAGE}}/${APP_NAME}:${TAG}
 
-# TODO: QA
 # [docker] tag image from VERSION file
 tag-version:
-	@echo "create tag it/${APP_NAME}:{{VERSION}} {{IMAGE}}/${APP_NAME}:${TAG}"
-	docker tag it/${APP_NAME}:{{VERSION}} {{IMAGE}}/${APP_NAME}:${TAG}
+	@echo "create tag ${APP_NAME}:{{VERSION}} {{IMAGE}}/${APP_NAME}:${TAG}"
+	docker tag ${APP_NAME}:{{VERSION}} {{IMAGE}}/${APP_NAME}:${TAG}

markdown/just.md

@@ -0,0 +1,30 @@
+# justfile
+
+> [just](https://just.systems/man/en/chapter_1.html) is a handy way to save and run project-specific commands.
+> 
+> Commands, called recipes, are stored in a file called justfile with syntax inspired by make:
+
+## [Install](https://just.systems/man/en/chapter_4.html)
+```bash
+# macOS
+brew install just
+
+# Ubuntu/Debian
+curl -q 'https://proget.makedeb.org/debian-feeds/prebuilt-mpr.pub' | gpg --dearmor | sudo tee /usr/share/keyrings/prebuilt-mpr-archive-keyring.gpg 1> /dev/null
+echo "deb [arch=amd64 signed-by=/usr/share/keyrings/prebuilt-mpr-archive-keyring.gpg] https://proget.makedeb.org prebuilt-mpr $(lsb_release -cs)" | sudo tee /etc/apt/sources.list.d/prebuilt-mpr.list
+sudo apt update
+sudo apt install just -y
+```
+
+## Usage
+```bash
+# default commands
+just
+
+# custom directives
+just buildx         # [docker] intel build
+just pull           # [docker] pull latest image
+just run            # [docker] run local image
+just up             # [docker] start docker-compose container
+just down           # [docker] remove docker-compose container(s) and networks
+```