add docs

Author: lebalz

.devcontainer/devcontainer.json

@@ -11,7 +11,8 @@
 		"ghcr.io/rails/devcontainer/features/postgres-client": {
 			"version": "17"
 		},
-		"ghcr.io/code-fabrik/features/dokku-cli:latest": {}
+		"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.
@@ -27,8 +28,40 @@
 				"dbaeumer.vscode-eslint",
 				"motivesoft.vscode-uuid-generator",
 		        "dbaeumer.vscode-eslint",
-				"esbenp.prettier-vscode"
-			]
+				"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": {

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: