Skip to content
This repository was archived by the owner on May 5, 2023. It is now read-only.

Update README.md #24

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

Update README.md #24

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
56c8537
Update README.md
geoknee Apr 26, 2023
fdfaf73
improve readme
geoknee Apr 27, 2023
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
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,22 @@ UI component demos deployed here: https://nitro-storybook.netlify.app/
## Storybook

Components can be viewed by running `yarn storybook` or `npm run storybook` from the `packages/site` directory.

## Running manual integration tests

You will need to spin up:

- a local `hardhat network` instance running with default settings
- a GUI/Dashboard server (x1) `yarn start` in the `site` package
- `n` browser tabs loading the GUI from the above server (try `n=3` for example, Alice/Irene/Bob in the below diagram)
- `n` `go-nitro` RPC servers ("Nitro as a Service") `go run .` in http://github.com/statechannels/go-nitro. See the readme of that repo for more information. Servers will each require:

- unique message port
- unique rpc port
- unique channel signing key (a funded account on hardhat will be selected automatically)

And then drive the network by clicking on a button in the dashboard of one of the participants.

The interactions are shown in this diagram:

![Screenshot 2023-04-26 at 17 08 11](https://user-images.githubusercontent.com/1833419/234635968-016eb70a-debd-413f-a0d9-bce76af78783.png)