Skip to content

[docs] Add Running a Full Demo section at the end of the README #27

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

Open
couimet wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[docs] Add Running a Full Demo section at the end of the README #27

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
49 changes: 48 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,51 @@ In a separate terminal execute:
`$ npx hardhat run ./scripts/deploy.js --network localhost`

### 7. Start frontend
`$ npm run start`
`$ npm run start`

## Running a Full Demo

This demo uses a Hardhat deployment script that initializes 4 predefined accounts:

- **`buyer`**: Account with index 0 in Hardhat
- **`seller`**: Account with index 1 in Hardhat
- **`inspector`**: Account with index 2 in Hardhat
- **`lender`**: Account with index 3 in Hardhat

### Prerequisites

1. Map the above accounts to your **Metamask wallet**:
- Import the private keys for these accounts into Metamask if you haven't already.

---

### Steps to Complete a Property Purchase

1. **Open the Demo App**: Navigate to [http://localhost:3000](http://localhost:3000) in your browser.
1. **Connect Metamask**: Connect your wallet to the app.
- The currently active account in Metamask doesn't matter during this step.
1. **Select a Property**: Click on a property to view its details.
1. **Perform Actions with the Specified Accounts**:
- **Inspector**:
- Switch to the `inspector` account in Metamask.
- Click `Approve Inspection` and confirm the transaction in Metamask.
- **Lender**:
- Switch to the `lender` account in Metamask.
- Click `Approve and Lend` and confirm the transaction in Metamask.
- **Buyer**:
- Switch to the `buyer` account in Metamask.
- Click `Buy` and confirm the transaction in Metamask.
- **Seller**:
- Switch to the `seller` account in Metamask.
- Click `Approve & Sell` and confirm the transaction in Metamask.

---

### Expected Result

After completing the last step, the property details should display:
**"Owned by 0xf39F...2266"**

This indicates that the property is now owned by the `buyer` account (`0xf39F...2266`), which corresponds to index 0 in Hardhat.

**Note**: Hardhat initializes account addresses in a predictable way when starting up, ensuring consistent behavior during each run.