Skip to content
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.

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

feature: nodejs docs #154

Merged
merged 8 commits into from
Jan 16, 2024
Merged
52 changes: 51 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,19 @@ This repository is subjected to incentives for the community to contribute to th

## Setup

You should install the dependencies using Yarn to deploy this code to a local testnet. The project uses Hardhat as a development environment. Which relies on Node.js (Recommended v18.16.0).
- Yarn:

You should install the dependencies using Yarn to deploy this code to a local testnet. The project uses Hardhat as a development environment. Which relies on Node.js (Recommended [v18.16.0](https://nodejs.org/download/release/v18.16.0/)).

Install Yarn globally:

```
npm install --global yarn
```

Check your Yarn version:

```
yarn --version
```

Expand All @@ -24,6 +33,47 @@ Later on, install the dependencies using Yarn.
yarn install
```

- NodeJS:

Windows: download the recommended version here: [v18.16.0](https://nodejs.org/download/release/v18.16.0/)

MacOS/Linux: run the following command to install the correct version:

```
nvm install 18.16.0
```

To make sure that NodeJS is installed correctly, open the integrated terminal in MacOS/Linux, or command line (cmd), PowerShell in Windows.
Run the following commands to verify the installed versions:

```
node -v
```

You should see this:

```
v18.16.0
```

And also run this:

```
npm -v
```

You should see this:

```
9.5.1
```

Later on, install the dependencies using NodeJS.

```
npm install
```

### Environment Variables

The project comes with a `.env.example` file. You should rename it to `.env` and fill the variables with your own values. Most RPC providers offer free testnet nodes. You can use [Alchemy](https://www.alchemy.com/) or [Infura](https://infura.io/) to get a free node.
Expand Down