Skip to content

Commit d8aa548

Browse files
authored
chore: add build step to README (#52)
1 parent 47dd4f5 commit d8aa548

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ Follow these steps to run the full end-to-end demo on your machine.
1010

1111
### Prerequisites
1212

13-
* **Node.js**: Use version 18.x or later.
14-
* **Yarn**: This repository uses Yarn for package management.
15-
* **Docker & Docker Compose**: Required to run the backend relay server.
16-
* **Expo Go App**: To run the mobile wallet demo, you'll need the [Expo Go](https://expo.dev/go) app on your iOS or Android device.
13+
- **Node.js**: Use version 18.x or later.
14+
- **Yarn**: This repository uses Yarn for package management.
15+
- **Docker & Docker Compose**: Required to run the backend relay server.
16+
- **Expo Go App**: To run the mobile wallet demo, you'll need the [Expo Go](https://expo.dev/go) app on your iOS or Android device.
1717

1818
### 1. Installation
1919

@@ -25,6 +25,12 @@ cd mobile-wallet-protocol
2525
yarn install
2626
```
2727

28+
To use the demo apps locally you also have to build the packages.
29+
30+
```bash
31+
yarn build
32+
```
33+
2834
### 2. Run the Backend Relay Server
2935

3036
The relay server runs in a Docker container. Use the provided Docker Compose file to start it.
@@ -122,4 +128,4 @@ To work around this, the `yarn release` command executes a wrapper script (`scri
122128
3. **Restores and Updates `package.json`**: After the release tool completes, the script reads the new version number. It then restores the original `package.json` contents from the backup and updates its version to match the new release version.
123129
4. **Finalizes the Release**: Finally, the script removes the backup file and runs `yarn install` and `yarn lint:fix` to ensure the project is in a consistent state.
124130

125-
This approach ensures that our development workflow, which relies on Yarn workspaces to link the demo apps with local packages, remains unbroken, while also producing a clean and correct release.
131+
This approach ensures that our development workflow, which relies on Yarn workspaces to link the demo apps with local packages, remains unbroken, while also producing a clean and correct release.

0 commit comments

Comments
 (0)