ethereum-org-website

(★ 5,958)

Ethereum.org is a primary online resource for the Ethereum community.

Owner Repos

go-ethereum ★ 51,306

Go implementation of the Ethereum protocol

Go
EIPs ★ 13,954

The Ethereum Improvement Proposal repository

Python
mist ★ 7,422

[DEPRECATED] Mist. Browse and use Ðapps on the Ethereum network.

JavaScript
aleth ★ 3,963

Aleth – Ethereum C++ client, tools and libraries

C++
consensus-specs ★ 3,959

Ethereum Proof-of-Stake Consensus Specifications

Python
pyethereum ★ 2,664

Next generation cryptocurrency network

File Explorer

ZIP Download

Showing a partial file list — download the zip above to see everything.

  • .all-contributorsrc
  • .env.example
  • .eslintrc.json
  • .gitattributes
  • .gitignore
  • .lintstagedrc.js

# Installation Guide

node
Prerequisites
  • Node.js Node.js (managed via .nvmrc)
  • pnpm latest
  • Corepack latest

Setup Steps

git clone https://github.com/ethereum/ethereum-org-website.git

Clone the repository locally.

nvm use

Activate the canonical Node.js version.

corepack enable

Enable corepack for package management.

pnpm install

Install project dependencies.

cp .env.example .env.local

Copy the environment variable configuration file.

pnpm dev

Run the local development server.

Key Commands

pnpm install

Install all package dependencies for the project.

pnpm dev

Start the local development environment.

You can access localhost:3000 in your browser to view the site locally.

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Showing a partial file list.

Link
Example

Command Glossary

Commands referenced in this DOCs, explained below.

🔍

corepack

View Details ▼

Zero-runtime-dependency package acting as bridge between Node projects and their package managers.

corepack enable

Add the Corepack shims to the Node.js installation directory to make them available as global commands:

corepack enable --install-directory {{path/to/directory}}

Add the Corepack shims to a specific directory:

corepack disable

Remove the Corepack shims from the Node.js installation directory:

🔍

git checkout

View Details ▼

Checkout a branch or paths to the working tree.

git checkout -b {{branch_name}}

Create and switch to a new branch:

git checkout -b {{branch_name}} {{reference}}

Create and switch to a new branch based on a specific reference (branch, remote/branch, tag are examples of valid references):

git checkout {{branch_name}}

Switch to an existing local branch:

🔍

git clone

View Details ▼

Clone an existing repository.

git clone {{remote_repository_location}} {{path/to/directory}}

Clone an existing repository into a new directory (the default directory is the repository name):

git clone --recursive {{remote_repository_location}}

Clone an existing repository and its submodules:

git clone {{[-n|--no-checkout]}} {{remote_repository_location}}

Clone only the `.git` directory of an existing repository:

🔍

git commit

View Details ▼

Commit files to the repository.

git commit

Open an editor to write a message and commit staged files to the repository:

git commit {{[-m|--message]}} "{{message}}"

Commit staged files to the repository with the specified message:

git commit {{[-F|--file]}} {{path/to/commit_message_file}}

Commit staged files with a message read from a file:

🔍

git fetch

View Details ▼

Download objects and refs from a remote repository.

git fetch

Fetch the latest changes from the default remote upstream repository (if set):

git fetch {{remote_name}}

Fetch new branches from a specific remote upstream repository:

git fetch --all

Fetch the latest changes from all remote upstream repositories:

🔍

git merge

View Details ▼

Merge branches.

git merge {{branch_name1 branch_name2 ...}}

Merge branches into your current branch:

git merge {{[-e|--edit]}} {{branch_name}}

Edit the merge message:

git merge --no-ff {{branch_name}}

Merge a branch and create a merge commit:

🔍

git push

View Details ▼

Push commits to a remote repository.

git push

Send local changes in the current branch to its default remote counterpart:

git push {{remote_name}} {{local_branch}}

Send changes from a specific local branch to its remote counterpart:

git push {{[-u|--set-upstream]}} {{remote_name}} {{local_branch}}

Send changes from a specific local branch to its remote counterpart, and set the remote one as the default push/pull target of the local one:

🔍

git remote

View Details ▼

Manage set of tracked repositories ("remotes").

git remote {{[-v|--verbose]}}

List existing remotes with their names and URLs:

git remote show {{remote_name}}

Show information about a remote:

git remote add {{remote_name}} {{remote_url}}

Add a remote:

🔍

nvm

View Details ▼

Install, uninstall, or switch between Node.js versions under the fish shell.
Supports version numbers like "12.8" or "v16.13.1", and labels like "stable", "system", etc.

nvm install {{node_version}}

Install a specific version of Node.js:

nvm install {{node_version}}

Install a specific version of Node.js:

nvm use {{node_version}}

Use a specific version of Node.js in the current shell:

🔍

pnpm

View Details ▼

Fast, disk space efficient package manager for Node.js.
Manage Node.js projects and their module dependencies.

pnpm init

Create a `package.json` file:

pnpm {{[i|install]}}

Download all the packages listed as dependencies in `package.json`:

pnpm add {{module_name}}@{{version}}

Download a specific version of a package and add it to the list of dependencies in `package.json`:

🔍

yarn

View Details ▼

JavaScript and Node.js package manager alternative.

yarn global add {{module_name}}

Install a module globally:

yarn install

Install all dependencies referenced in the `package.json` file (the `install` is optional):

yarn add {{module_name}}@{{version}}

Install a module and save it as a dependency to the `package.json` file (add `--dev` to save as a dev dependency):

🔍

apt

View Details ▼

Package manager for Debian-based distributions.
Intended as a user-friendly alternative to `apt-get` for interactive use.
For equivalent commands in other package managers, see <https://wiki.archlinux.org/title/Pacman/Rosetta>.

sudo apt update

Update the list of available packages and versions (recommended before running other `apt` commands):

apt search {{package}}

Search packages by name or description:

apt list {{package}}

Search packages by name only (supports wildcards like `*`):

// repository documentation