Assembly instructions

vercel/next.js

The React Framework

Node.jsNext.jsRust#blog#browser#compiler#components

Difficulty: Moderate
Time: 30 min or more
Stars: ★ 143,326
Activity: Updated this month
License: MIT
Open issues: 3,791
Got it running: Be the first
Looked up: 2 h ago

Saved setup from 2 h ago

Start here

Website ↗nextjs.orgThe project's own site.In the browser ↗Open in GitHub CodespacesThe repo ships a dev container, so nothing to install.

Setup script in the repo

The maintainers included scripts/setup-node.sh. Run it from the cloned folder after reading it.

bash scripts/setup-node.sh

Also: scripts/setup-wasi-env.sh

Will it work on my device?

Yes, it runs on macOS

You'll build it yourself with Node.js, Rust.

Checking for

5 steps on macOS

Clone the repository

Needs Git: xcode-select --install

git clone https://github.com/vercel/next.js.git
cd next.js

Install the required runtimes

Node.js v20, Rust nightly-2026-10-06

# needs nvm: brew install nvm (or https://github.com/nvm-sh/nvm)
nvm install 20
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
rustup show  # installs the pinned toolchain

Install dependencies

corepack enable
pnpm install
cargo build

4
Run it
```
pnpm dev
```
5
Run the tests
```
pnpm test
cargo test
```

Did you get it running?

No reports for macOS yet.

Still stuck? Get a written guide

Claude reads the 19 key files and writes a step-by-step guide for macOS. Once written, it's saved for everyone.

Parts list

1×Node.js v20runtime
1×Rust nightly-2026-10-06runtime
1×pnpm pnpm@12.9.1package manager

18× settings in .env

AGILITY_CMS_GUID
AGILITY_CMS_API_FETCH_KEYsecret
AGILITY_CMS_API_PREVIEW_KEYsecret
AGILITY_CMS_SECURITY_KEYsecret
NEXT_PUBLIC_CLOUDFLARE_TURNSTILE_SITE_KEYsecret
CLOUDFLARE_TURNSTILE_SECRET_KEYsecret
AUTH_GITHUB_ID
AUTH_GITHUB_SECRETsecret
AUTH_SECRETsecret
REDIS_URL
NEXT_PUBLIC_AUTH0_CLIENT_ID
NEXT_PUBLIC_AUTH0_DOMAIN
NEXT_PUBLIC_AUTH0_ADMIN_EMAIL
AUTH0_ISSUER_BASE_URL
AUTH0_CLIENT_ID
AUTH0_CLIENT_SECRETsecret
AUTH0_BASE_URL
AUTH0_SECRETsecret

Share this manual

Good to know

Monorepo (workspaces) — install from the repo root.
Cargo workspace — pick a crate with cargo run -p <name>.
Dev Container config found — you can open it in VS Code Dev Containers or GitHub Codespaces for a zero-setup environment.
Has AGENTS.md — instructions for coding agents. You can open Claude Code (or another agent) in the cloned folder and ask it to do the setup for you.
Nested projects: .github/actions/needs-triage/package.json, .github/actions/next-integration-stat/package.json, .github/actions/pr-auto-label/package.json, .github/actions/pr-stack-ci-gate/package.json and 11 more

package.json scripts (99)

new-errorturbo gen error
new-testturbo gen test
pr-adoptnode scripts/adopt-pr.js
cleanpnpm --filter "./packages/**" run clean && pnpm --filter "./packages/**" exec node ../../scripts/rm.mjs dist node_modules
buildturbo run build --remote-cache-timeout 60 --summarize true
build-allturbo run build build-native-auto --remote-cache-timeout 60 --summarize true
devturbo run dev --parallel --filter="!@next/bundle-analyzer-ui"
bench:render-pipelinetsx bench/render-pipeline/benchmark.ts
bench:render-pipeline:analyzetsx bench/render-pipeline/analyze-profiles.ts
bench:render-pipeline:clienttsx bench/render-pipeline/client-trace.ts
bench:dev-validationtsx bench/dev-validation/benchmark.ts
pack-nexttsx scripts/pack-next.ts
evalnode run-evals.js
eval:upgradenode evals/next-upgrade/run.js
test-typestsc
test-unitjest test/unit/ packages/next/ packages/font
test-devscripts/run-jest.sh --mode=dev --bundler=webpack --headless --
test-dev-webpackscripts/run-jest.sh --mode=dev --bundler=webpack --headless --
test-dev-experimentalscripts/run-jest.sh --mode=dev --bundler=webpack --experimental --headless --
test-dev-experimental-webpackscripts/run-jest.sh --mode=dev --bundler=webpack --experimental --headless --
test-dev-rspackscripts/run-jest.sh --mode=dev --bundler=rspack --headless --
test-dev-experimental-rspackscripts/run-jest.sh --mode=dev --bundler=rspack --experimental --headless --
test-dev-turboscripts/run-jest.sh --mode=dev --bundler=turbo --headless --
test-dev-experimental-turboscripts/run-jest.sh --mode=dev --bundler=turbo --experimental --headless --
test-startscripts/run-jest.sh --mode=start --bundler=webpack --headless --

Files we read (19)

.devcontainer/devcontainer.json

.github/workflows/build_and_deploy.yml

.github/workflows/build_and_test.yml

.github/workflows/build_reusable.yml

.github/workflows/integration_tests_reusable.yml

.github/workflows/pr_ci_comment.yml

.github/workflows/retry_deploy_test.yml

.node-version

Cargo.toml

contributing.md

examples/auth/.env.example

examples/auth0/.env.local.example

examples/blog-with-comment/.env.local.example

examples/cloudflare-turnstile/.env.local.example

examples/cms-agilitycms/.env.local.example

package.json

pnpm-workspace.yaml

readme.md

rust-toolchain.toml

Branch canary · 35,194 files in the repo

Reading the repo

Opening the box…

Parts list

1×Node.js v20runtime

1×Rust nightly-2026-10-06runtime

1×pnpm pnpm@12.9.1package manager

18× settings in .env

AGILITY_CMS_GUID
AGILITY_CMS_API_FETCH_KEYsecret
AGILITY_CMS_API_PREVIEW_KEYsecret
AGILITY_CMS_SECURITY_KEYsecret
NEXT_PUBLIC_CLOUDFLARE_TURNSTILE_SITE_KEYsecret
CLOUDFLARE_TURNSTILE_SECRET_KEYsecret
AUTH_GITHUB_ID
AUTH_GITHUB_SECRETsecret
AUTH_SECRETsecret
REDIS_URL
NEXT_PUBLIC_AUTH0_CLIENT_ID
NEXT_PUBLIC_AUTH0_DOMAIN
NEXT_PUBLIC_AUTH0_ADMIN_EMAIL
AUTH0_ISSUER_BASE_URL
AUTH0_CLIENT_ID
AUTH0_CLIENT_SECRETsecret
AUTH0_BASE_URL
AUTH0_SECRETsecret

Start here

Yes, it runs on macOS

5 steps on macOS

Clone the repository

Install the required runtimes

Install dependencies

Run it

Run the tests

Did you get it running?

Still stuck? Get a written guide

Opening the box…

Start here

Yes, it runs on macOS

5 steps on macOS

Clone the repository

Install the required runtimes

Install dependencies

Run it

Run the tests

Did you get it running?

Still stuck? Get a written guide