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
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,19 +39,37 @@ 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).
You should install the dependencies using Yarn (used in the project) or npm to deploy this code. The project uses Hardhat as a development environment. Which relies on Node.js (Recommended version [v18.16.0](https://nodejs.org/download/release/v18.16.0/)).

To make sure that NodeJS is installed correctly, open the integrated terminal and run the following command:

```
node -v
```

### Yarn:

Install Yarn globally and check if the version appears:

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

Later on, install the dependencies using Yarn.
Install the dependencies using Yarn:

```
yarn install
```

### npm:

Install the dependencies using npm:

```
npm install
```

### Environment Variables

The project comes with a `.env.example` file. You should rename it to `.env` and fill the variables with your 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