From 425e35c56497e82c4934831dd3c915df0f9a608f Mon Sep 17 00:00:00 2001 From: Georg <50551748+georgelgeback@users.noreply.github.com> Date: Mon, 26 Jan 2026 15:42:43 +0100 Subject: [PATCH 1/2] Update README with Codespaces instructions --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 0f4205b8..9222686c 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,18 @@ This repo uses VSCode's Dev Containers extension to standardize the development environment and avoid headache-inducing installation. All development will happen inside a Docker container which installs the same dependencies and versions on every developer's machine. ## Installation + +You can either run the project locally or via Github codespaces. Since Github has way better servers than most of us and running our projects can be quite demanding for most computers, we recommend using codespaces. In either case, the actual experience when coding will be similar. + +### Using Codespaces + +1. Go to the main Github page and click the green "Code" button +2. Go to the codespaces tab and create a new codespace +3. Everything should set itself up automatically, wait until it says "your application running is available at...". +4. If you want to get back to the codespace after closing it, go to the repository and once again click the green CODE button. It should show up in a list. You can also choose to open the codespace using vscode if you don't like the URL bar at the top, by clicking the three dots next to the codespace. + +### Running Locally + 0. Using Windows? First set up WSL 2. - Press Windows `⊞` -> "Turn Windows features on or off". Enable "Windows Subsystem for Linux", might need to enable "Virtual Machine Platform" also. - Open Powershell as admin. @@ -49,3 +61,4 @@ The file `requirements.txt` lists all pip packages and versions needed. To add a new package, add a new line in `requirements.txt` specifiying package name and exact version. Then, in terminal, while in the `WebWebWeb` folder, run `pip install -r requirements.txt`. + From 17f02513377ce4ac268de2d24f074ea4026814c0 Mon Sep 17 00:00:00 2001 From: Manfred Malmros Date: Tue, 27 Jan 2026 16:00:31 +0100 Subject: [PATCH 2/2] Add info about codespace in vscode Port forwarding only works in vscode --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9222686c..c90f48c1 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ You can either run the project locally or via Github codespaces. Since Github ha 1. Go to the main Github page and click the green "Code" button 2. Go to the codespaces tab and create a new codespace 3. Everything should set itself up automatically, wait until it says "your application running is available at...". -4. If you want to get back to the codespace after closing it, go to the repository and once again click the green CODE button. It should show up in a list. You can also choose to open the codespace using vscode if you don't like the URL bar at the top, by clicking the three dots next to the codespace. +4. If you want to get back to the codespace after closing it, go to the repository and once again click the green CODE button. It should show up in a list. You can also choose to open the codespace using vscode if you don't like the URL bar at the top or want to connect to the frontend, by clicking the three dots next to the codespace. ### Running Locally @@ -62,3 +62,4 @@ The file `requirements.txt` lists all pip packages and versions needed. To add a new package, add a new line in `requirements.txt` specifiying package name and exact version. Then, in terminal, while in the `WebWebWeb` folder, run `pip install -r requirements.txt`. +