isabella232 / ethereum-hackathon-setup-checker

This project lets you check if your development environment is ready for an Ethereum hackaton

Ethereum Hackathon Development Environment Checker

This project lets you check if your development environment is ready for an Ethereum hackathon.

This project and its instructions are specific to Node.js-based Ethereum development. If you are in doubt about using Node.js in the hackathon, we recommend you follow them anyway, as most Ethereum libraries and tools use Node.

How do you use it?

To make sure your development environment is ready, you need to copy and paste these commands in a terminal.

git clone https://github.com/nomiclabs/ethereum-hackathon-setup-checker.git
cd ethereum-hackathon-setup-checker
npm install

If any of them failed, your environment is not ready and you need to follow the instructions from the next section.

If they went well, you should see a confirmation message, and your development environment is ready for the hackathon.

Setting up your development environment

This section has instructions for setting up your environment in a clean installation of your operating system. Feel free to skip any step if you think they aren't necessary.

Linux

Ubuntu

This guide uses the official Node.js PPA, so we can choose the version of Node.js we want.

Copy and paste these commands in a terminal:

sudo apt update
sudo apt install curl git
sudo apt install build-essential # We need this to build native dependencies
curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
sudo apt install nodejs

MacOS

Before following this guide, make sure you have git installed. Otherwise, follow these instructions.

There are multiple ways of installing Node.js in MacOs, this guide uses Node Version Manager (nvm).

Copy and paste these commands in a terminal:

curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.35.2/install.sh | bash
nvm install 10
nvm use 10
nvm alias default 10
npm install npm --global # Upgrade npm to the latest version
npm install -g node-gyp # Make sure we have node-gyp installed

# This next setp is needed to build native dependencies.
# A popup will appear and you have to proceed with an installation.
# It will take some time, and may download a few GB of data.
xcode-select --install

Windows

This guide requires some manual installations. Please follow them.

1. If you don't have git installed, please download and install it.
2. Install Node.js 10.x by going to its download page, downloading node-v10.XX.XX-x64.msi, and running it.
3. Open your terminal as Administrator and run the following command: npm install --global --production windows-build-tools. It will take several minutes and may download a few GB of data.

Upgrading your version of Node.js

If your version of Node.js is too old, this project will let you know during its installation. If this happens, follow these instructions.

Linux

Ubuntu

1. Remove nodejs with sudo apt remove nodejs.
2. Go to the NodeSource's Node.js Binary Distributions, and install their PPA for the version of Node.js that you are looking for.
3. Run sudo apt update && sudo apt install nodejs

MacOS

If you followed our recommended installation steps, you can change your Node.js version using nvm.

For example, this is how you'd upgrade to Node.js 12.x:

nvm install 12
nvm use 12
nvm alias default 12
npm install npm --global # Upgrade npm to the latest version
npm install -g node-gyp # Make sure we have node-gyp installed

Windows

You need to follow the same installation instructions but choosing another version of Node.js from its website.