Merge pull request #43 from GBSL-Informatik/dev-container

Dev container

Author: lebalz

.devcontainer/Dockerfile

@@ -0,0 +1,12 @@
+FROM mcr.microsoft.com/devcontainers/typescript-node:1-22-bookworm
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment if you want to install an additional version of node using nvm
+# ARG EXTRA_NODE_VERSION=10
+# RUN su node -c "source /usr/local/share/nvm/nvm.sh && nvm install ${EXTRA_NODE_VERSION}"
+
+# [Optional] Uncomment if you want to install more global node modules
+# RUN su node -c "npm install -g <your-package-list-here>"

.devcontainer/devcontainer.json

@@ -0,0 +1,72 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/javascript-node-postgres
+{
+	"name": "Teaching-API",
+	"dockerComposeFile": "docker-compose.yml",
+	"service": "app",
+	"workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}",
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	"features": {
+		"ghcr.io/devcontainers/features/github-cli:1": {},
+		"ghcr.io/rails/devcontainer/features/postgres-client": {
+			"version": "17"
+		},
+		"ghcr.io/code-fabrik/features/dokku-cli:latest": {},
+	    "ghcr.io/georglauterbach/dev-container-features/cache-vscode-extensions:0": {}
+	},
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// This can be used to network with other containers or with the host.
+	"forwardPorts": [3002, 5432],
+	// Use 'postCreateCommand' to run commands after the container is created.
+	"postCreateCommand": "yarn install",
+	// Configure tool-specific properties.
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"Prisma.prisma",
+				"mhutchie.git-graph",
+				"dbaeumer.vscode-eslint",
+				"motivesoft.vscode-uuid-generator",
+		        "dbaeumer.vscode-eslint",
+				"esbenp.prettier-vscode",
+				"ms-ossdata.vscode-pgsql",
+				"GitHub.copilot",
+				"GitHub.vscode-pull-request-github"
+			],
+			"settings": {
+				"pgsql.serverGroups": [
+					{
+						"name": "Servers",
+						"id": "9B1DBC9B-951B-4E3D-AC65-7D4CDE1773A0",
+						"isDefault": true
+					}
+				],
+				"pgsql.connections": [
+					{
+						"id": "30A5E0E0-9901-4311-913B-98F78549DD64",
+						"groupId": "9B1DBC9B-951B-4E3D-AC65-7D4CDE1773A0",
+						"authenticationType": "SqlLogin",
+						"connectTimeout": 15,
+						"applicationName": "vscode-pgsql",
+						"clientEncoding": "utf8",
+						"sslmode": "disable",
+						"server": "db",
+						"user": "postgres",
+						"port": "5432",
+						"database": "teaching_api",
+						"password": "postgres",
+						"savePassword": true,
+						"profileName": "TeachingAPI",
+						"copilotAccessMode": "ro",
+						"expiresOn": 0
+					}
+				]
+			}
+		}
+	},
+	"remoteEnv": {
+		"DATABASE_URL": "postgresql://postgres:postgres@db:5432/teaching_api?schema=public"
+	}
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

.devcontainer/docker-compose.yml

@@ -0,0 +1,46 @@
+version: '3.8'
+
+services:
+    app:
+        build:
+            context: ..
+            dockerfile: .devcontainer/Dockerfile
+
+        volumes:
+            - ../..:/workspaces:cached
+
+        # Overrides default command so things don't shut down after the process ends.
+        command: sleep infinity
+
+        environment:
+            - NODE_ENV=development
+            - DATABASE_URL=postgresql://postgres:postgres@db:5432/teaching_api?schema=public
+            - PORT=3002
+
+        # Runs app on the same network as the database container, allows "forwardPorts" in devcontainer.json function.
+        network_mode: service:db
+
+        depends_on:
+            - db
+
+        # Use "forwardPorts" in **devcontainer.json** to forward an app port locally.
+        # (Adding the "ports" property to this file will not forward from a Codespace.)
+
+    db:
+        image: postgres:17.2
+        restart: unless-stopped
+        volumes:
+            - postgres-data:/var/lib/postgresql/data
+        environment:
+            POSTGRES_PASSWORD: postgres
+            POSTGRES_USER: postgres
+            POSTGRES_DB: teaching_api
+        ports:
+            - '3002:3002'
+            - '5432:5432'
+
+        # Add "forwardPorts": ["5432"] to **devcontainer.json** to forward PostgreSQL locally.
+        # (Adding the "ports" property to this file will not forward from a Codespace.)
+
+volumes:
+    postgres-data:

README.md

@@ -1,6 +1,29 @@
 # Teaching Website Backend
 The backend for our teaching website.
 
+## Run the Project with VS Code
+
+The Project is ready to be used with dev containers. You only need a recent version of [Docker](https://www.docker.com/). Then you can reopen the project in a devcontainer (`Ctrl+Shift+P` > `Dev Containers: Reopen in Container`).
+
+Setup your local env - inside the devcontainer **you should not set** `DATABASE_URL` yourself.
+
+```bash
+USER_ID="<your uuid>"
+USER_EMAIL="<your mail>"
+USER_ROLE="ADMIN"
+NO_AUTH="true"
+```
+
+The `USER_ID` and `USER_EMAIL` are used only for seeding the database and are not strictly needed.
+The `USER_ID` is the `ID` attribute from the response of [Graph-Explorer/v1.0/me](https://developer.microsoft.com/en-us/graph/graph-explorer) - you need to log in first...
+
+
+The Project builds and you can run
+1. `yarn run db:migrate && yarn run db:seed` (needed only on the initial startup)
+2. `yarn run dev`
+
+And done...
+
 ## Dev Dependencies
 
 In order to use `.env` files, the [dotenv-cli](https://www.npmjs.com/package/dotenv-cli) must be installed globally: