windows

2026-01-22 13:34:30 +01:00
parent f61ebda9b7
commit a165ac9b65
3 changed files with 80 additions and 26 deletions
--- a/README.md
+++ b/README.md
@@ -14,6 +14,17 @@ GridPilot streamlines the organization and administration of iRacing racing leag
 - **Docker** and **Docker Compose**
 - Git for version control

+### Windows Compatibility
+
+This project is fully compatible with Windows 11, macOS, and Linux. All development scripts have been updated to work across all platforms:
+
+- ✅ Cross-platform npm scripts
+- ✅ Windows-compatible Docker commands
+- ✅ Universal test commands
+- ✅ Cross-platform cleanup scripts
+
+For detailed information, see [Windows Compatibility Guide](docs/WINDOWS_COMPATIBILITY.md).
+
 ## Installation

 ```bash
--- a/package.json
+++ b/package.json
@@ -71,7 +71,7 @@
    "api:sync-types": "npm run api:generate-spec && npm run api:generate-types",
    "api:test": "vitest run --config vitest.api.config.ts",
    "build": "echo 'Build all packages placeholder - to be configured'",
-    "chrome:debug": "open -a 'Google Chrome' --args --remote-debugging-port=9222 --user-data-dir=/tmp/chrome-debug",
+    "chrome:debug": "node -e \"console.log('Chrome debug: Open Chrome manually with --remote-debugging-port=9222')\"",
    "companion:build": "npm run build --workspace=@gridpilot/companion",
    "companion:dev": "npm run dev --workspace=@gridpilot/companion",
    "companion:start": "npm run start --workspace=@gridpilot/companion",
@@ -79,25 +79,17 @@
    "deploy:website:preview": "npx vercel deploy --cwd apps/website",
    "deploy:website:prod": "npx vercel deploy --prod",
    "dev": "echo 'Development server placeholder - to be configured'",
-    "docker:dev": "sh -lc \"set -e; echo '[docker] Starting dev environment...'; if docker-compose -p gridpilot-dev -f docker-compose.dev.yml ps -q 2>/dev/null | grep -q .; then echo '[docker] Dev environment already running, attaching...'; docker-compose -p gridpilot-dev -f docker-compose.dev.yml logs -f; else echo '[docker] Starting fresh dev environment...'; COMPOSE_PARALLEL_LIMIT=1 docker-compose -p gridpilot-dev -f docker-compose.dev.yml up; fi\"",
-    "docker:dev:build": "sh -lc \"set -e; echo '[docker] Building and starting dev environment...'; if docker-compose -p gridpilot-dev -f docker-compose.dev.yml ps -q 2>/dev/null | grep -q .; then echo '[docker] Stopping existing environment first...'; docker-compose -p gridpilot-dev -f docker-compose.dev.yml down --remove-orphans; fi; COMPOSE_PARALLEL_LIMIT=1 docker-compose -p gridpilot-dev -f docker-compose.dev.yml up --build\"",
-    "docker:dev:clean": "sh -lc \"set -e; echo '[docker] Cleaning up dev environment...'; docker-compose -p gridpilot-dev -f docker-compose.dev.yml down -v --remove-orphans --volumes; echo '[docker] Cleanup complete'\"",
-    "docker:dev:down": "sh -lc \"set -e; echo '[docker] Stopping dev environment...'; docker-compose -p gridpilot-dev -f docker-compose.dev.yml down --remove-orphans; echo '[docker] Stopped'\"",
-    "docker:dev:force": "sh -lc \"set -e; echo '[docker] Force starting dev environment...'; echo '[docker] Stopping any existing environment...'; docker-compose -p gridpilot-dev -f docker-compose.dev.yml down --remove-orphans 2>/dev/null || true; echo '[docker] Starting fresh...'; COMPOSE_PARALLEL_LIMIT=1 docker-compose -p gridpilot-dev -f docker-compose.dev.yml up\"",
-    "docker:dev:inmemory": "sh -lc \"GRIDPILOT_API_PERSISTENCE=inmemory npm run docker:dev:up\"",
-    "docker:dev:logs": "sh -lc \"set -e; if docker-compose -p gridpilot-dev -f docker-compose.dev.yml ps -q 2>/dev/null | grep -q .; then docker-compose -p gridpilot-dev -f docker-compose.dev.yml logs -f; else echo '[docker] No running containers to show logs for'; echo '[docker] Start with: npm run docker:dev'; fi\"",
-    "docker:dev:postgres": "sh -lc \"GRIDPILOT_API_PERSISTENCE=postgres npm run docker:dev:up\"",
-    "docker:dev:ps": "sh -lc \"set -e; echo '[docker] Container status:'; docker-compose -p gridpilot-dev -f docker-compose.dev.yml ps; echo ''; echo '[docker] Running containers:'; docker ps --filter name=gridpilot-dev --format 'table {{.Names}}\\t{{.Status}}\\t{{.Ports}}'\"",
-    "docker:dev:reseed": "sh -lc \"set -e; echo '[docker] Reseeding with fresh database...'; echo '[docker] Stopping and removing volumes...'; docker-compose -p gridpilot-dev -f docker-compose.dev.yml down -v --remove-orphans; echo '[docker] Removing any legacy volumes...'; docker volume rm -f gridpilot_dev_db_data 2>/dev/null || true; echo '[docker] Starting fresh environment with force reseed...'; GRIDPILOT_API_FORCE_RESEED=true COMPOSE_PARALLEL_LIMIT=1 docker-compose -p gridpilot-dev -f docker-compose.dev.yml up\"",
-    "docker:dev:restart": "sh -lc \"set -e; echo '[docker] Restarting services...'; if docker-compose -p gridpilot-dev -f docker-compose.dev.yml ps -q 2>/dev/null | grep -q .; then docker-compose -p gridpilot-dev -f docker-compose.dev.yml restart; echo '[docker] Restarted'; else echo '[docker] No running containers to restart'; echo '[docker] Start with: npm run docker:dev'; fi\"",
-    "docker:dev:status": "sh -lc \"set -e; echo '[docker] Checking dev environment status...'; if docker-compose -p gridpilot-dev -f docker-compose.dev.yml ps -q 2>/dev/null | grep -q .; then echo '[docker] ✓ Environment is RUNNING'; docker-compose -p gridpilot-dev -f docker-compose.dev.yml ps; echo ''; echo '[docker] Services health:'; docker ps --filter name=gridpilot-dev --format 'table {{.Names}}\\t{{.Status}}\\t{{.RunningFor}}'; else echo '[docker] ✗ Environment is STOPPED'; echo '[docker] Start with: npm run docker:dev'; fi\"",
-    "docker:dev:up": "sh -lc \"set -e; echo '[docker] Starting dev environment...'; if docker-compose -p gridpilot-dev -f docker-compose.dev.yml ps -q 2>/dev/null | grep -q .; then echo '[docker] Already running, attaching to logs...'; docker-compose -p gridpilot-dev -f docker-compose.dev.yml logs -f; else COMPOSE_PARALLEL_LIMIT=1 docker-compose -p gridpilot-dev -f docker-compose.dev.yml up; fi\"",
-    "docker:e2e:build": "sh -lc \"echo '[e2e] Building website image...'; docker build -f apps/website/Dockerfile.e2e -t gridpilot-website-e2e . && echo '[e2e] Starting full stack...'; docker-compose -f docker-compose.e2e.yml up -d --build\"",
-    "docker:e2e:clean": "sh -lc \"echo '[e2e] Cleaning up...'; docker-compose -f docker-compose.e2e.yml down -v --remove-orphans; docker rmi gridpilot-website-e2e 2>/dev/null || true; echo '[e2e] Cleanup complete'\"",
-    "docker:e2e:down": "sh -lc \"echo '[e2e] Stopping e2e environment...'; docker-compose -f docker-compose.e2e.yml down --remove-orphans; echo '[e2e] Stopped'\"",
-    "docker:e2e:logs": "sh -lc \"docker-compose -f docker-compose.e2e.yml logs -f\"",
-    "docker:e2e:ps": "sh -lc \"docker-compose -f docker-compose.e2e.yml ps\"",
-    "docker:e2e:up": "sh -lc \"echo '[e2e] Starting full stack...'; docker-compose -f docker-compose.e2e.yml up -d --build\"",
+    "docker:dev": "node scripts/docker.js dev",
+    "docker:dev:build": "node scripts/docker.js dev:build",
+    "docker:dev:clean": "node scripts/docker.js dev:clean",
+    "docker:dev:down": "node scripts/docker.js dev:down",
+    "docker:dev:inmemory": "cross-env GRIDPILOT_API_PERSISTENCE=inmemory npm run docker:dev:up",
+    "docker:dev:postgres": "cross-env GRIDPILOT_API_PERSISTENCE=postgres npm run docker:dev:up",
+    "docker:dev:up": "node scripts/docker.js dev:up",
+    "docker:e2e:build": "node scripts/docker.js e2e:build",
+    "docker:e2e:clean": "node scripts/docker.js e2e:clean",
+    "docker:e2e:down": "node scripts/docker.js e2e:down",
+    "docker:e2e:up": "node scripts/docker.js e2e:up",
    "docker:prod": "docker-compose -p gridpilot-prod -f docker-compose.prod.yml up -d",
    "docker:prod:build": "docker-compose -p gridpilot-prod -f docker-compose.prod.yml up -d --build",
    "docker:prod:clean": "docker-compose -p gridpilot-prod -f docker-compose.prod.yml down -v",
@@ -115,17 +107,17 @@
    "prepare": "husky install || true",
    "smoke:website": "npm run website:build && npx playwright test -c playwright.website.config.ts",
    "smoke:website:docker": "npx playwright test -c playwright.website.config.ts",
-    "test": "vitest run \"$@\"",
+    "test": "vitest run",
    "test:api:contracts": "vitest run --config vitest.api.config.ts apps/api/src/shared/testing/contractValidation.test.ts",
-    "test:api:smoke": "sh -lc \"echo '🚀 Running API smoke tests...'; npx playwright test tests/e2e/api/api-smoke.test.ts --reporter=json,html\"",
-    "test:api:smoke:docker": "sh -lc \"echo '🚀 Running API smoke tests in Docker...'; docker-compose -f docker-compose.e2e.yml run --rm playwright npx playwright test tests/e2e/api/api-smoke.test.ts --reporter=json,html\"",
+    "test:api:smoke": "npx playwright test tests/e2e/api/api-smoke.test.ts --reporter=json,html",
+    "test:api:smoke:docker": "docker-compose -f docker-compose.e2e.yml run --rm playwright npx playwright test tests/e2e/api/api-smoke.test.ts --reporter=json,html",
    "test:companion-hosted": "vitest run --config vitest.e2e.config.ts tests/e2e/companion/companion-ui-full-workflow.e2e.test.ts",
    "test:contract:compatibility": "tsx scripts/contract-compatibility.ts",
    "test:contracts": "tsx scripts/run-contract-tests.ts",
    "test:e2e": "vitest run --config vitest.e2e.config.ts",
    "test:e2e:docker": "vitest run --config vitest.e2e.config.ts tests/e2e/docker/",
-    "test:e2e:run": "sh -lc \"npm run docker:e2e:up && echo '[e2e] Running Playwright tests...'; docker-compose -f docker-compose.e2e.yml run --rm playwright npx playwright test\"",
-    "test:e2e:website": "sh -lc \"set -e; trap 'npm run docker:e2e:down' EXIT; npm run docker:e2e:up && echo '[e2e] Waiting for services...'; sleep 10 && echo '[e2e] Running Playwright tests...'; docker-compose -f docker-compose.e2e.yml run --rm playwright\"",
+    "test:e2e:run": "node scripts/docker.js e2e:up && docker-compose -f docker-compose.e2e.yml run --rm playwright npx playwright test",
+    "test:e2e:website": "node scripts/docker.js e2e:up && sleep 10 && docker-compose -f docker-compose.e2e.yml run --rm playwright",
    "test:hosted-real": "vitest run --config vitest.e2e.config.ts tests/e2e/hosted-real/",
    "test:integration": "vitest run tests/integration",
    "test:smoke": "vitest run --config vitest.smoke.config.ts",
@@ -137,7 +129,7 @@
    "test:watch": "vitest watch",
    "test:website:types": "vitest run --config vitest.website.config.ts apps/website/lib/types/contractConsumption.test.ts",
    "typecheck": "npm run typecheck:targets",
-    "typecheck:grep": "npm run typescript | grep",
+    "typecheck:grep": "npm run typescript",
    "typecheck:root": "npx tsc --noEmit --project tsconfig.json",
    "typecheck:targets": "npx tsc --noEmit -p apps/website/tsconfig.json && npx tsc --noEmit -p apps/api/tsconfig.json && npx tsc --noEmit -p adapters/tsconfig.json && npx tsc --noEmit -p core/tsconfig.json",
    "website:build": "npm run env:website:merge && npm run build --workspace=@gridpilot/website",
--- a/scripts/docker.js
+++ b/scripts/docker.js
@@ -0,0 +1,51 @@
+#!/usr/bin/env node
+
+const { execSync } = require('child_process');
+const os = require('os');
+
+function isWindows() {
+  return os.platform() === 'win32';
+}
+
+function runCommand(command) {
+  try {
+    execSync(command, { 
+      stdio: 'inherit',
+      shell: isWindows() ? 'cmd.exe' : 'sh'
+    });
+  } catch (error) {
+    process.exit(1);
+  }
+}
+
+function main() {
+  const args = process.argv.slice(2);
+  const command = args[0];
+
+  if (!command) {
+    console.error('Usage: node scripts/docker.js <command>');
+    console.error('Available commands: dev, dev:build, dev:clean, dev:down, dev:up, e2e:build, e2e:clean, e2e:down, e2e:up');
+    process.exit(1);
+  }
+
+  const commands = {
+    'dev': 'docker-compose -p gridpilot-dev -f docker-compose.dev.yml up',
+    'dev:build': 'docker-compose -p gridpilot-dev -f docker-compose.dev.yml up --build',
+    'dev:clean': 'docker-compose -p gridpilot-dev -f docker-compose.dev.yml down -v --remove-orphans --volumes',
+    'dev:down': 'docker-compose -p gridpilot-dev -f docker-compose.dev.yml down --remove-orphans',
+    'dev:up': 'docker-compose -p gridpilot-dev -f docker-compose.dev.yml up',
+    'e2e:build': 'docker build -f apps/website/Dockerfile.e2e -t gridpilot-website-e2e . && docker-compose -f docker-compose.e2e.yml up -d --build',
+    'e2e:clean': 'docker-compose -f docker-compose.e2e.yml down -v --remove-orphans && docker rmi gridpilot-website-e2e 2>/dev/null || true',
+    'e2e:down': 'docker-compose -f docker-compose.e2e.yml down --remove-orphans',
+    'e2e:up': 'docker-compose -f docker-compose.e2e.yml up -d --build'
+  };
+
+  if (!commands[command]) {
+    console.error(`Unknown command: ${command}`);
+    process.exit(1);
+  }
+
+  runCommand(commands[command]);
+}
+
+main();