Skip to content

docs: add Node.js and pnpm setup tip #8642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Alex000115 wants to merge 1 commit into
base: main
Choose a base branch
from
+2 −0
Open

docs: add Node.js and pnpm setup tip #8642

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ npm install thirdweb
Visit the [developer portal](https://portal.thirdweb.com) for full documentation.

### 🚀 Quick Start
> Tip: Make sure you are using Node.js v18+ and have `pnpm` installed for a smoother local development experience.
Copy link
Contributor

@coderabbitai coderabbitai bot Jan 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Search for Node version constraints in repo config files
echo "=== Searching for Node version constraints ==="
rg -n 'engines|node-version|NODE_VERSION' . --type json --type yaml --type yml 2>/dev/null || true

echo ""
echo "=== Looking for .nvmrc and similar version files ==="
fd -e nvmrc -e npmrc -e node-version 2>/dev/null || true

echo ""
echo "=== Checking package.json for engines field ==="
if [ -f "package.json" ]; then
  cat -n package.json | grep -A5 -B5 'engines' || echo "No engines field found"
fi

echo ""
echo "=== Checking for volta configuration ==="
if [ -f "package.json" ]; then
  cat -n package.json | grep -A5 -B5 'volta' || echo "No volta config found"
fi

echo ""
echo "=== Looking for CI config files ==="
fd -e yml -e yaml -path '*/.github/*' -o -path '*/.gitlab-ci*' -o -path '*/azure-pipelines*' 2>/dev/null | head -10 || true

Repository: thirdweb-dev/js

Length of output: 607

Update Node.js version requirement from v18+ to v20+.

The README states "Node.js v18+" but package.json specifies "node": ">=20". Update the tip to reflect the actual minimum requirement.

🤖 Prompt for AI Agents 
In `@README.md` at line 45, Update the README tip to match package.json's engine
requirement by changing the Node.js version from "v18+" to "v20+"; locate the
sentence "Tip: Make sure you are using Node.js v18+ and have `pnpm`
installed..." in README.md and replace "v18+" with "v20+" so the documentation
aligns with the "node": ">=20" entry in package.json.



#### For React Applications

Expand Down