Skip to content

Environment Requirements

SunDevil311 edited this page Jun 14, 2025 · 5 revisions

This page outlines the essential environment requirements and setup recommendations for contributing to the Network Pro™ Web Presence project.

✅ Runtime Requirements

Ensure the following versions are installed on your system:

"engines": {
  "node": ">=22.0.0 <25",
  "npm": ">=11.0.0 <12"
}

These constraints are defined in package.json and automatically verified during setup.

Node Version Managers

To simplify environment setup and ensure consistency, we recommend using a Node version manager:

This repository includes .nvmrc and .node-version files to streamline setup with these tools.

🧰 Local Setup Script

Run the following to bootstrap your local dev environment:

./scripts/bootstrap.local.sh

This script:

  • Detects your OS (macOS/Linux)
  • Installs Playwright dependencies (if required)
  • Copies .env.template to .env if not already present
  • Installs Node packages and validates the environment

📦 Manual Setup

If you prefer a manual setup:

git clone https://github.com/netwk-pro/netwk-pro.github.io.git
cd netwk-pro.github.io
cp .env.template .env
npm install

Then run:

npx playwright install

This installs required browser binaries for testing.

🧪 Post-Install Checks

After npm install, several validations run automatically:

  • Node and npm version checks
  • Friendly guidance if your setup is out of spec

Clone this wiki locally