From 2418e03f8a43516d98c8dc6ea5b6b31a99623e6c Mon Sep 17 00:00:00 2001 From: Imbus <> Date: Tue, 13 Feb 2024 11:30:41 +0100 Subject: [PATCH 1/2] Windows notes --- README.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2afa6b1..d9e54c0 100644 --- a/README.md +++ b/README.md @@ -48,9 +48,18 @@ sudo pacman -S make go nodejs npm podman just brew install make go nodejs npm podman just ``` -Further instructions will be provided for native Windows if there is demand for it. -[Windows](https://www.microsoft.com/en-us/windows): (Requires [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install)) (Untested) +[Windows](https://www.microsoft.com/en-us/windows): +Unfortunately, [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl/install) is required for the build process. Running any form of containerized workload on windows is currently unsupported. More info [here](https://podman.io/docs/installation#windows). From my understanding, WSL also requires virtualization extensions to be enabled in the BIOS, which is not always the case for all users. -```bash -sudo apt install -y make golang nodejs podman just -``` +It is possible to run the code on Windows, but this will be without the use of containers or any other build tools that are not available on Windows. +You will also eventually need to install the database server, which will not be containerized. + +My recommendation would be to make WSL your primary development environment if you are on Windows. This will drop you into an Ubuntu environment, in which you can follow the instructions above. + +If you're still dead set on using windows ou will need the following: + +- [Go](https://go.dev/) +- [Node & npm](https://nodejs.org/en/) +- [MariaDB](https://mariadb.org/) / [MySQL](https://www.mysql.com/) / [PostgreSQL](https://www.postgresql.org/) (This is undecided so far) + +With some grit and determination, you can get it to work. It's not recommended, but I (Imbus) will try to help you. From 7e8467244529ff81af3131698a685babe981dbd3 Mon Sep 17 00:00:00 2001 From: Imbus <> Date: Tue, 13 Feb 2024 11:40:32 +0100 Subject: [PATCH 2/2] Further windows notes related to WSL --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d9e54c0..fc55126 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,15 @@ You will also eventually need to install the database server, which will not be My recommendation would be to make WSL your primary development environment if you are on Windows. This will drop you into an Ubuntu environment, in which you can follow the instructions above. -If you're still dead set on using windows ou will need the following: +You should consult the [WSL documentation](https://docs.microsoft.com/en-us/windows/wsl/install), but for any recent version of windows, installation essentially boils down to running the following command in **PowerShell as an administrator**: + +```powershell +wsl --install +``` + +If you get any errors related to virtualization, you will need to enable virtualization in the BIOS. This is a common issue, and you can find a guide for your specific motherboard online. This is a one-time operation and will not affect your windows installation. This setting is usually called "VT-x" or "AMD-V" and is usually found in the CPU settings. If you can't find it, shoot me a message and I'll find it for you. + +If you're **still dead set** on using a vanilla Windows environment, you will need the following: - [Go](https://go.dev/) - [Node & npm](https://nodejs.org/en/)