Install Node.js & npm

Before you can develop smart contracts on WireFluid using professional tools like Hardhat, you need to install Node.js and npm (Node Package Manager).

ℹ️ Quick Info
Time Required: ~5-10 minutes
Difficulty: Beginner
What You’ll Install: Node.js v18 or higher and npm (included with Node.js)

What is Node.js?

Node.js is a JavaScript runtime that allows you to run JavaScript code outside of a web browser. It’s essential for:

• Running development tools like Hardhat and Foundry
• Installing and managing smart contract libraries
• Compiling and deploying contracts from the command line
• Running automated tests for your contracts

npm (Node Package Manager) comes bundled with Node.js and is used to install JavaScript packages and dependencies.

System Requirements

Before installing, ensure your system meets these requirements:

Check if Node.js is Already Installed

Before installing, check if Node.js is already on your system:

Step 1: Open your terminal

• macOS: Press Cmd + Space, type “Terminal”, and press Enter
• Windows: Press Win + R, type “cmd”, and press Enter
• Linux: Press Ctrl + Alt + T

Step 2: Check Node.js version

node --version

Step 3: Check npm version

npm --version

If you see version numbers:

• Node.js version should be v18.0.0 or higher
• npm version should be 9.0.0 or higher

If your versions are lower, follow the installation steps below to update.

⚠️ Warning
Node.js v16 and below are no longer supported. Make sure to install v18 or higher for compatibility with modern development tools.

Installation Instructions

Choose your operating system:

macOS

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

brew install node@20

node --version
npm --version

v20.x.x
10.x.x

node --version
npm --version

brew upgrade node

Windows

node --version
npm --version

v20.x.x
10.x.x

winget install OpenJS.NodeJS.LTS

Linux

sudo apt update

curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt-get install -y nodejs

node --version
npm --version

sudo apt update
sudo apt upgrade nodejs

curl -fsSL https://rpm.nodesource.com/setup_20.x | sudo bash -
sudo dnf install -y nodejs

curl -fsSL https://rpm.nodesource.com/setup_20.x | sudo bash -
sudo yum install -y nodejs

node --version
npm --version

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash

source ~/.bashrc
# or
source ~/.zshrc

nvm install 20
nvm use 20
nvm alias default 20

node --version
npm --version

nvm list                  # List installed versions
nvm install 18            # Install Node.js 18
nvm use 18                # Switch to Node.js 18
nvm alias default 20      # Set default version

Post-Installation Configuration

After installing Node.js and npm, follow these steps to optimize your setup:

1. Configure npm for Global Packages

By default, npm installs global packages to a system directory that requires administrator privileges. Change this to a local directory:

macOS/Linux:

mkdir ~/.npm-global
npm config set prefix '~/.npm-global'

Add this line to your ~/.bashrc, ~/.zshrc, or ~/.bash_profile:

export PATH=~/.npm-global/bin:$PATH

Reload your shell:

source ~/.bashrc
# or
source ~/.zshrc

Windows:

npm config set prefix "%APPDATA%\npm"

The PATH should be updated automatically. If not, add %APPDATA%\npm to your system PATH.

2. Update npm to Latest Version

Even though npm comes with Node.js, you can update it to the latest version:

npm install -g npm@latest

Verify the update:

npm --version

3. Test Your Installation

Create a test file to ensure everything works:

mkdir ~/test-node
cd ~/test-node
echo "console.log('Node.js is working!');" > test.js
node test.js

You should see:

Node.js is working!

Essential npm Commands

Now that you have npm installed, here are the most common commands you’ll use:

# Install a package locally (in your project)
npm install <package-name>
 
# Install a package globally (available system-wide)
npm install -g <package-name>
 
# Install all dependencies from package.json
npm install
 
# Initialize a new Node.js project
npm init
 
# Check for outdated packages
npm outdated
 
# Update packages
npm update
 
# Uninstall a package
npm uninstall <package-name>

Installing Development Tools for WireFluid

Now that Node.js and npm are installed, you can install the tools needed for WireFluid development:

Install Hardhat (Recommended)

npm install -g hardhat

Verify installation:

npx hardhat --version

Install TypeScript (Optional but Recommended)

npm install -g typescript

Install pnpm (Alternative to npm, faster)

npm install -g pnpm

💡 What’s next? After installing Node.js and npm, proceed to Setup MetaMask Wallet to configure your blockchain wallet.

Troubleshooting

Common Issues and Solutions

”node: command not found”

Solution:

1. Close and reopen your terminal
2. Check if Node.js is in your PATH:

   echo $PATH

3. Reinstall Node.js and ensure “Add to PATH” is selected

”npm: command not found” (but Node.js works)

Solution:

# macOS/Linux
brew reinstall node
 
# Windows
# Reinstall Node.js from nodejs.org

Permission denied when installing packages globally

Solution:

• DON’T use sudo with npm!
• Follow the Post-Installation Configuration steps above
• Or use NVM instead

”EACCES: permission denied” errors

Solution (macOS/Linux):

sudo chown -R $(whoami) ~/.npm
sudo chown -R $(whoami) /usr/local/lib/node_modules

Slow npm installations

Solution:

1. Clear npm cache:

   npm cache clean --force

2. Use a faster package manager:

   npm install -g pnpm

Different Node.js version needed for different projects

Solution: Use NVM to manage multiple versions:

nvm install 18
nvm install 20
nvm use 18  # Switch to Node 18
nvm use 20  # Switch to Node 20

Verifying Your Setup

Run this comprehensive check to ensure everything is properly installed:

# Check Node.js version
node --version
 
# Check npm version  
npm --version
 
# Check if npx is available (comes with npm 5.2+)
npx --version
 
# Test Node.js execution
node -e "console.log('Node.js is working')"
 
# Test npm by listing global packages
npm list -g --depth=0

Expected output:

v20.x.x
10.x.x
10.x.x
Node.js is working
/usr/local/lib
└── npm@10.x.x

Next Steps

Now that Node.js and npm are installed, continue with the prerequisites:

• Setup MetaMask Wallet → - Install and configure your blockchain wallet
• Configure WireFluid Network → - Connect MetaMask to WireFluid
• Get Testnet Tokens → - Request free test $WIRE
• Choose Your Development Path → - Remix, Hardhat, or Foundry?

Additional Resources

• Official Node.js Documentation 
• npm Documentation 
• NVM GitHub Repository 
• Hardhat Documentation 
• Node.js Best Practices 

Success!
Congratulations! You’ve successfully installed Node.js and npm. You’re ready to start building on WireFluid!