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 description on how to kick start test cases #466

Closed
wants to merge 1 commit into from
Closed

add description on how to kick start test cases #466

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,26 @@ Please refer to `package.json`.
[prettier-badge]: https://img.shields.io/badge/code_style-prettier-ff69b4.svg
[prettier-link]: https://github.com/prettier/prettier
[release-notes]: https://github.com/alephium/alephium-web3/releases

## Test
Follow steps shown below to run test cases

1. Open terminal ( use git bash if your OS = windows)
2. Run the following command
```
pnpm install
```
3. Run the following command
```
pnpm build
```
4. Run a devnet node by following this document:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To successfully run all tests (including the ones with WalletConnect), we need to use the docker-compose file under the docker directory.

Please take a look at the CI config.
https://github.com/alephium/alephium-web3/blob/master/.github/workflows/test.yml#L24-L26

https://docs.alephium.org/full-node/getting-started#devnet

5. Successfull node running should display 3 servers are running:
![image info](./documents/successful_node_running.png)

6. Run command on terminal
```
pnpm test
```
Binary file added documents/successful_node_running.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.