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

Updated README & Issue Template #2

Merged
merged 3 commits into from
Aug 29, 2024
Merged

Updated README & Issue Template #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0aa4fb5
Update README
SeiyaKobayashi Aug 29, 2024
8dbbbb6
Update issue template
SeiyaKobayashi Aug 29, 2024
dd4f84d
Update README
SeiyaKobayashi Aug 29, 2024
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
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ assignees: ''

## ❓ Motivation

<!-- Summarize motivation/background of this feature request. Why should our SDK have this feature? -->
<!-- Summarize motivation/background of this feature request. Why should our code examples have this feature? -->

## 🎨 Description

Expand Down
15 changes: 9 additions & 6 deletions packages/v1/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,20 @@ The first thing to do is to build packages.
$ yarn run compile
```

### 2. Run Local Network
### 2. Set Environment Variables

Start running local Hardhat network and its accompanying node.
Run the following commands to generate `.env` file.

```sh
$ yarn run node
$ yarn run env
```

### 3. Set Environment Variables
### 3. Run Local Network

Run the following commands to generate `.env` file.
Start running local Hardhat network and its accompanying node.

```sh
$ yarn run env
$ yarn run node
```

### 4. Deploy Contracts
Expand All @@ -37,6 +37,9 @@ $ yarn run env
$ yarn run deploy
```

> [!TIP]
> If you get `read ECONNRESET` error, try running steps 3 & 4 again (with cache enabled).

### 5. Run Code Examples

Finally, let's run our code examples!
Expand Down