Skip to content

Commit

Permalink
Merge pull request #154 from luislucena16/feature/nodejs-docs
Browse files Browse the repository at this point in the history
feature: nodejs docs
  • Loading branch information
0xneves authored Jan 16, 2024
2 parents 35ae861 + 85afd62 commit 305bfe3
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 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 All @@ -75,4 +93,4 @@ yarn deploy <network>

## Contributing

- To know more about how you can contribute [see our notion page](https://blockful.notion.site/Swaplace-Call-for-Contributors-6e4895d2a7264f679439ab2c124603fe).
- To know more about how you can contribute [see our notion page](https://blockful.notion.site/Swaplace-Call-for-Contributors-6e4895d2a7264f679439ab2c124603fe).

0 comments on commit 305bfe3

Please sign in to comment.