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

Include node requirements in the readme #15

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Include node requirements in the readme #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f930b59
docs: update readme to include node version
May 21, 2021
fe5cf2d
chore: fix a typo
May 21, 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
1 change: 1 addition & 0 deletions .nvmrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
12.16
5 changes: 3 additions & 2 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ Clone the repository and `cd` into the new directory.

### Installing dependencies

**Make sure you have Yarn v1.17.3 installed**. For easy management of specific Yarn versions, we recommend using [Yarn Version Manager (YVM)](https://github.com/tophat/yvm).
- **Make sure you have `Node v12.16` installed**. For easy management of specific Node versions, we recommend using Node Version Manager ([mac / linux](https://github.com/nvm-sh/nvm)) ([windows](https://github.com/coreybutler/nvm-windows)).
- **Make sure you have `Yarn v1.17.3` installed**. For easy management of specific Yarn versions, we recommend using [Yarn Version Manager (yvm)](https://github.com/tophat/yvm) (mac / linux). Under windows, install the correct yarn version while running in your node 12.16 nvm environment.

To install the dependencies:

Expand All @@ -29,7 +30,7 @@ will
- deploy this bytecode
- run a `jest` test test for lesson 1 only

Your task is to make this tests pass, and then move on with `yarn tutorial lesson2.test` and so on up to lesson 16. Hopefully, you should learn something about the nitro contracts in the process. This exercise would be very useful for anyone interested in building a state channel wallet that runs on nitro protocol.
Your task is to make this test pass, and then move on with `yarn tutorial lesson2.test` and so on up to lesson 16. Hopefully, you should learn something about the nitro contracts in the process. This exercise would be very useful for anyone interested in building a state channel wallet that runs on nitro protocol.

DApp developers may wish to build against our State Channel Wallet API (coming soon), which abstracts most of the complexity away into a much simpler interface.

Expand Down