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.

Sign up for GitHub

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

Add getting started section to README #136

Closed
wants to merge 2 commits into from
Closed

Add getting started section to README #136

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8ccac0b
Add getting started section to README
rootulp Sep 7, 2021
be3d2ce
Add steps for Infura token
rootulp Sep 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 19 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,25 @@

## Development

To use console.log during Solidity development, follow the [guides](https://hardhat.org/guides/hardhat-console.html).

## Available Functionality
### Getting started

1. Clone this repo
1. Create an Alchemy token
1. Navigate to [Alchemy](https://www.alchemy.com/) and create an account
1. Click **Create app** and provide a name (e.g. set-protocol-v2)
1. Navigate to your new app and click **View key** then copy the token (the part after `https://eth-mainnet.alchemyapi.io/v2/`)
1. Create an Infura token
1. Navigate to [Infura](https://infura.io) and create an account
1. Click **Create new project** and provide a name (e.g. set-protocol-v2)
1. Navigate to your new project and copy the project id (the part after `https://mainnet.infura.io/v3/`)
1. Copy the default environment variable file to a `.env` file

```bash
cp .env.prod .env
```
1. Populate `ALCHEMY_TOKEN` and `INFURA_TOKEN` with the tokens generated in the previous steps

To use `console.log` during Solidity development, follow this [guide](https://hardhat.org/guides/hardhat-console.html).

### Run Hardhat EVM

Expand Down