Merge pull request #149 from 64J0/64J0-1

Dockerize this application

Author: spruce

.dockerignore

@@ -0,0 +1,6 @@
+.husky/
+.vscode/
+node_modules/
+.gitignore
+LICENSE
+README.md

Dockerfile

@@ -0,0 +1,36 @@
+# This Dockerfile is used to set up a container environment with all the required
+# tools to use this project. You only need to provide the necessary environment
+# variables, as described in the README.
+#
+# Docker version that I used: 20.10.17
+#
+# If you're interested in testing other base images, take a look at this reference:
+# https://github.com/BretFisher/nodejs-rocks-in-docker
+FROM node:16-bullseye-slim
+
+ARG USERNAME=migrator
+ARG USER_UID=2000
+ARG USER_GID=$USER_UID
+
+LABEL version="0.1.5"
+LABEL description="Migrate Issues, Wiki from gitlab to github."
+
+WORKDIR /app
+
+# Add a non-root user, so later we can explore methods to scale
+# privileges within this container.
+# https://code.visualstudio.com/remote/advancedcontainers/add-nonroot-user#_creating-a-nonroot-user
+RUN groupadd --gid $USER_GID $USERNAME
+RUN useradd --uid $USER_UID --gid $USER_GID -m $USERNAME
+RUN chown -R $USERNAME /app
+
+# Copy the project contents to the container
+COPY --chown=$USERNAME . /app
+
+USER $USERNAME
+
+# Install dependencies
+RUN npm i
+
+# Start the process
+ENTRYPOINT ["/bin/bash", "-c", "npm run start"]

Makefile

@@ -0,0 +1,17 @@
+CONTAINER_IMAGE ?= node-gitlab-2-github
+CONTAINER_TAG ?= latest
+LOCAL_PWD = $(shell pwd)
+
+.PHONY: build-image
+build-image: ##@docker Build the Docker image
+	docker build -t $(CONTAINER_IMAGE):$(CONTAINER_TAG) .
+
+.PHONY: docker-run
+docker-run:
+	docker run $(CONTAINER_IMAGE):$(CONTAINER_TAG)
+
+.PHONY: docker-run-bind
+docker-run-bind:
+	docker run \
+		--mount type=bind,source="$(LOCAL_PWD)/settings.ts",target="/app/settings.ts",readonly \
+		$(CONTAINER_IMAGE):$(CONTAINER_TAG)

README.md

@@ -40,6 +40,34 @@ The user must be a member of the project you want to copy. This user must be the
 1. edit settings.ts
 1. run `npm run start`
 
+### Docker
+
+If you don't have Node.js installed in your local environment and don't want to install it you can use the Dockerized approach. 
+
+1. Make sure that you have [Docker](https://docs.docker.com/engine/install/) installed in your computer. You can test running `docker version` in the terminal.
+1. `cp sample_settings.ts settings.ts`
+1. edit settings.ts
+1. `docker build -t node-gitlab-2-github:latest .`, or, you can use `make build-image`
+1. `docker run node-gitlab-2-github:latest`, or, you can use `make docker-run`
+
+If you want to let it run in the background (detached mode), just use the following command:
+
+1. `docker run -d node-gitlab-2-github:latest`
+
+### Docker with bind mounts
+
+In order to optimize the usage of the dockerized application, one can use the `bind mounts` feature of Docker ([Docker docs](https://docs.docker.com/storage/bind-mounts/)). This way, whenever you change the `settings.ts` file in the host environment it will change in the container filesystem as well.
+
+The process to use this trick is pretty much the same we presented before, the only different is the addition of a flag in the docker command to tell it what is the directory/file to be bound.
+
+1. Make sure that you have [Docker](https://docs.docker.com/engine/install/) installed in your computer. You can test running `docker version` in the terminal.
+1. `cp sample_settings.ts settings.ts`
+1. edit settings.ts
+1. `docker build -t node-gitlab-2-github:latest .`, or, you can use `make build-image`
+1. This command must work for **Linux** or **Mac**: `docker run --mount type=bind,source="$(pwd)/settings.ts",target="/app/settings.ts",readonly node-gitlab-2-github:latest`, or, you can use `make docker-run-bind`
+
+* If you want to run this last command in the Windows environment, please consult the Docker documentation on how to solve the problem of the pwd command expanding incorrectly there - [Docker documentation - Topics for windows](https://docs.docker.com/desktop/troubleshoot/topics/#topics-for-windows).
+
 ## Where to find info for the `settings.ts`
 
 ### gitlab