fix: broken docker configuration and update Docker.md

Author: Toxocious

.dockerignore

@@ -0,0 +1,16 @@
+# Dependency directories
+node_modules
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Documentation
+docs/
+
+# Misc.
+.vscode/
+build/

Dockerfile

@@ -1,21 +1,26 @@
 version: '3'
+
 services:
   webpack:
     container_name: dim-webpack
-    image: node:fermium
+    image: node:18
     ports:
-      - '8080:8080'
+      - 8080:8080
     working_dir: /usr/src/app
     command: >
-      bash -c "yarn install &&
-               yarn start"
+      bash -c "git config --global --add safe.directory /usr/src/app && yarn install --frozen-lockfile --prefer-offline && yarn start"
     environment:
-      - NODE_ENV=dev
+      - NODE_ENV=development
       - DOCKER=true
     restart: 'no'
     volumes:
       - .:/usr/src/app
+      - ./config/:/usr/src/app
       - node_modules:/usr/src/app/node_modules
-volumes: 
-  node_modules:
 
+volumes:
+  node_modules: {}
+
+networks:
+  dim:
+    name: dim

docker-compose.yml

@@ -1,68 +1,86 @@
-# Docker Compose Quick Start
-
-Install Dependencies, and start webpack, with Docker
-
-1. [Pre-requisites](#pre-requisites)
-1. [Docker-compose up](#docker-compose-up)
-1. Refer to [Entering your API credentials in CONTRIBUTING.md](CONTRIBUTING.md#enter-api-credentials)
+# Docker Development Quick Start
 
 ### Pre-Requisites
+To get started with Docker, follow the steps below.
 
-* Install Docker https://www.docker.com/get-started
-* Install docker-compose https://docs.docker.com/compose/install/
-* Follow the steps for getting an API key in [CONTRIBUTING.md](CONTRIBUTING.md#get-your-own-api-key)
+If you already have Docker installed on your machine, you may skip to step 2.
 
-### Docker Compose Up
+If you already have docker-compose installed on your machine, you may skip to step 3.
 
+1. Install Docker ([https://www.docker.com/get-started](https://www.docker.com/get-started))
+2. Install docker-compose ([https://docs.docker.com/compose/install/](https://docs.docker.com/compose/install/))
+3. Getting an API key in [CONTRIBUTING.md](CONTRIBUTING.md#get-your-own-api-key)
+
+### Managing DIM Docker Containers
 Run the following commands from the DIM cloned directory on your machine:
 
-* `docker-compose up` to build the dist and start yarn watcher
-* It will take a while for the dist files to build on the first startup while yarn installs dependencies
-* `ctrl+c` to stop
-* `docker-compose up -d` to start in detached mode
+* `docker-compose up` to start the docker containers and build the dist files
+* `docker-compose up -d` to start the containers and build the dist files in detached mode
 * `docker-compose stop` to stop detached mode
+* `docker-compose down` to stop the container and purge its containers and networks
+* `ctrl+c` to stop
 
-### Tips and Troubleshooting
+> Building dist files will take a while on the first startup while yarn installs dependencies and webpack builds DIM.
 
+### Tips and Troubleshooting
 You can get an interactive terminal with `docker-compose exec webpack bash`.
 
+This is very useful for troubleshooting issues that arise inside of the container when it's spun up.
+
+
+
 ## Commit hook won't run
+If you `git commit` inside the container, you may see one of the following warnings:
 
-If you `git commit` inside the container, you may see:
+```txt
+Can't find Husky, skipping pre-commit hook
+You can reinstall it using `npm install husky --save-dev` or delete this hook
+```
+```txt
+Can't find Husky, skipping prepare-commit-msg hook
+You can reinstall it using `npm install husky --save-dev` or delete this hook
+```
 
-    Can't find Husky, skipping pre-commit hook
-    You can reinstall it using 'npm install husky --save-dev' or delete this hook
-    Can't find Husky, skipping prepare-commit-msg hook
-    You can reinstall it using 'npm install husky --save-dev' or delete this hook
+These can be fixed with the suggested commands.
 
-This can be fixed with the suggested commands.
 
-## No editor on system
 
+## No editor on system
 When using `git commit`, you may encounter:
 
-    error: cannot run editor: No such file or directory
-    error: unable to start editor 'editor'
+- `error: cannot run editor: No such file or directory`
+- `error: unable to start editor 'editor'`
 
 This means that `git` cannot launch a text-editor for you to customize your commit-message with. A quick workaround is to use the `-m` flag, ex:
 
-    git commit -m "This is my commit message"
+```sh
+git commit -m "This is my commit message"
+```
 
-For an interactive editor, try:
+For an interactive editor, try `nano` or `vim`:
 
-    apt-get update
-    apt-get install nano
+```sh
+apt-get update
+apt-get install nano
+```
 
-This will install the `nano` editor. Another option is `vim`.
 
-## Node modules
 
-If you need to install new node dependencies, you should run those commands from inside the container. Once inside, use `yarn add NameOfTheDependency` as normal.
+## Installing new packages
+If you need to install new node dependencies, you should run those commands from inside the container via:
+```sh
+docker-compose exec webpack bash
+```
+
+Once inside, use `yarn add NameOfTheDependency` as normal.
 
-## Container terminates unexpectedly
 
+
+## Container terminates unexpectedly
 On Windows, you may see the error:
 
-    dim-webpack | error Command failed with exit code 137.
+```sh
+dim-webpack | error Command failed with exit code 137.
+```
 
 This may indicate that the Docker VM which hosts containers has run out of memory, and a higher setting is needed.