feat: Ensure Windows & Ubuntu compatibility.

.changeset/early-islands-scream.md

@@ -0,0 +1,6 @@
+---
+'@inkathon/contracts': minor
+'@inkathon/frontend': minor
+---
+
+Ensure & document Windows, Ubuntu, and macOS compatibility. 🌈

README.md

@@ -60,10 +60,29 @@ The frontend works out of the box, without a local node running, as the sample c
 
 > **Pre-requisites:**
 >
-> - Setup Node.js v16+ (recommended via [nvm](https://github.com/nvm-sh/nvm))
-> - Install [pnpm](https://pnpm.io/installation) (recommended via [Node.js Corepack](https://nodejs.org/api/corepack.html))
+> - Setup Node.js v18+ (recommended via [nvm](https://github.com/nvm-sh/nvm) with `nvm install 18`)
+> - Install [pnpm](https://pnpm.io/installation) (recommended via [Node.js Corepack](https://nodejs.org/api/corepack.html) or `npm i -g pnpm`)
 > - Clone this repository
 
+<details>
+<summary><strong>Special Instructions for Windows Users</strong></summary>
+
+> [!IMPORTANT]  
+> Windows users must either use [WSL](https://learn.microsoft.com/windows/wsl/install) (recommended) or a custom shell like [Git Bash](https://git-scm.com/downloads). PowerShell is not supported.
+
+> **Pre-requisites when using WSL for Linux:**
+>
+> - Install [WSL](https://learn.microsoft.com/windows/wsl/install) and execute _all_ commands in the WSL terminal
+> - Setup Node.js v18+ (recommended via [nvm](https://github.com/nvm-sh/nvm) with `nvm install 18`)
+> - Install the following npm packages globally:
+> - `npm i -g npm`
+> - `npm i -g pnpm node-gyp make`
+> - Clone this repository into the WSL file system (e.g. `/home/<user>/inkathon`).
+>
+> **Tip:** You can enter `\\wsl$\` in the top bar of the Windows Explorer to access the WSL file system visually.
+
+</details>
+
 ```bash
 # Install dependencies (once)
 # NOTE: This automatically creates an `.env.local` file

contracts/package.json

@@ -4,9 +4,9 @@
   "private": true,
   "version": "0.1.3",
   "scripts": {
-    "postinstall": "echo \"Creating empty 'development.ts' it does not exist…\" && [[ ! -e deployments/greeter/development.ts ]] && (command -v touch &> /dev/null && touch deployments/greeter/development.ts || copy /b deployments/greeter/development.ts +,,); true",
-    "test": "./test-all.sh",
-    "build": "./build-all.sh",
+    "postinstall": "bash postinstall.sh",
+    "test": "bash test-all.sh",
+    "build": "bash build-all.sh",
     "node": "substrate-contracts-node --dev --port 9944 --base-path ./.node-data",
     "script": "ts-node --cwd=scripts",
     "deploy": "pnpm run script deploy",

contracts/postinstall.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+set -eu
+
+# The script creates an empty 'development.ts' file if it doesn't exist yet.
+# This is kind of a hack to prevent a nasty Next.js error when running the frontend
+# for the first time after deploying to a local node which forces to clear `frontend/.next`.
+
+if [[ ! -e deployments/greeter/development.ts ]]; then
+    echo "Creating empty 'development.ts'…"
+    if command -v touch &> /dev/null; then
+        touch deployments/greeter/development.ts
+    else
+        copy /b deployments/greeter/development.ts +,,
+    fi
+else
+    echo "Great, 'development.ts' already exists! Skipping…"
+fi

frontend/package.json

@@ -8,9 +8,9 @@
     }
   },
   "scripts": {
-    "postinstall": "echo \"Creating default '.env.local' it does not exist…\" && [[ ! -e .env.local ]] && CP_CMD=$(command -v cp &> /dev/null && echo \"cp\" || echo \"copy\") && $CP_CMD .env.local.example .env.local; true",
+    "postinstall": "bash postinstall.sh",
     "dev": "NODE_ENV=development next dev",
-    "node": "pnpm run --filter contracts node",
+    "node": "pnpm run -F contracts node",
     "dev-and-node": "concurrently \"pnpm dev\" \"pnpm node\" --names \"Next,Node\" --kill-others",
     "build": "NODE_ENV=production next build",
     "start": "NODE_ENV=production next start",

frontend/postinstall.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+set -eu
+
+# This script creates a default '.env.local' file if it doesn't exist yet.
+# More information about environment variables: https://github.com/scio-labs/inkathon#environment-variables
+
+if [[ ! -e .env.local ]]; then
+    echo "Creating default '.env.local'…" 
+    CP_CMD=$(command -v cp &> /dev/null && echo "cp" || echo "copy")
+    $CP_CMD .env.local.example .env.local
+else
+    echo "Great, '.env.local' already exists! Skipping…"
+fi

package.json

@@ -16,6 +16,7 @@
     "dev": "pnpm run -F frontend dev",
     "build": "pnpm run -F frontend build",
     "start": "pnpm run -F frontend start",
+    "node": "pnpm run -F contracts node",
     "lint": "pnpm run -F '*' lint",
     "lint:fix": "pnpm run -F '*' lint:fix",
     "lint:format": "pnpm run -F '*' lint:format",