Devcontainer full setup (#160)

* Dev container from docker-compose

* Working dev container with mailcatcher and db

* Reduce down to minimal working

* Document dev container usage

Author: Lan2u

.devcontainer/devcontainer.json

@@ -1,16 +1,25 @@
 // For format details, see https://aka.ms/devcontainer.json. For config options, see the
 // README at: https://github.com/devcontainers/templates/tree/main/src/docker-existing-dockerfile
 {
-	"name": "Existing Dockerfile",
-	"build": {
-		// Sets the run context to one level up instead of the .devcontainer folder.
-		"context": "..",
-		"dockerfile": "../Dockerfile",
-		"target": "dev_container"
-	},
+	"name": "members-app",
+	"dockerComposeFile": "docker-compose.yaml",
+	"service": "app",
+	"workspaceFolder": "/workspace",
+	"shutdownAction": "stopCompose",
+	// Expose the application + the mailcatcher for checking emails.
+	"forwardPorts": [8080, 1080],
+	//  Wipes the database on every start.
+	"postStartCommand": "rm -rf /db && mkdir -p /db",
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"dbaeumer.vscode-eslint"
+			]
+		}
+	}
 
 	// Features to add to the dev container. More info: https://containers.dev/features.
-	"features": {}
+	// "features": {}
 
 	// Use 'forwardPorts' to make a list of ports inside the container available locally.
 	// "forwardPorts": [],

.devcontainer/docker-compose.yaml

@@ -0,0 +1,14 @@
+services:
+  app:
+    build:
+      context: ../
+      target: dev_container
+      dockerfile: Dockerfile
+    env_file: "../.env"
+    volumes:
+      - ../:/workspace:cached
+    command: sleep infinity
+    network_mode: service:mailcatcher
+
+  mailcatcher:
+    image: sj26/mailcatcher@sha256:238a915586b99dd957fed9dfc27fa36518e038b9d43368fbaf2e384968b6e36f

Makefile

@@ -64,3 +64,9 @@ release:
 
 login-%:
 	./scripts/login.ts $*
+
+# For use with devcontainer
+start:
+	npx tsx watch ./src/index.ts &
+	npx tsx watch ./src/sync-worker/index.ts
+

README.md

@@ -157,3 +157,15 @@ Not verified
 
 ## Fly.io
 - Deployment URL [makespace-app.fly.dev](https://makespace-app.fly.dev/)
+
+# DevContainer
+Dev containers are a way to create a reproducible dev environment https://code.visualstudio.com/docs/devcontainers/containers.
+
+Setup (vscode):
+1. Install the dev container extension from Microsoft
+2. Ctrl+Shift+P then type 'Dev Containers: Rebuild and Reopen in Container'
+3. Vscode will reload into the dev container - you can now develop with all the required tools already installed
+4. Type `make start` to start the application to perform manual local testing.
+
+Each time you start the dev container the database will be reset to empty.
+