Skip to content

Commit c92baa7

Browse files
committed
Update documentation for web app, testing, and commit guidelines.
Update `README.md` to list `webApp` under top-level repository components with a reference link to `webApp/README.md`, update tech stack description to Kotlin/JS, React, and Tailwind CSS, and add dedicated sections for running the Android app and running tests across all modules. Update commit guidelines in `README.md` and `AGENTS.md` to specify line break guidelines and the 80-character maximum line length requirement (with exceptions to avoid breaking hyperlinks). Add references to `CODING-STYLE.md` and `DEVELOPER-MODE.md`. Test: Manually verified rendered Markdown in `README.md` and `AGENTS.md`. Signed-off-by: David Zeuthen <zeuthen@gmail.com>
1 parent 28ef690 commit c92baa7

2 files changed

Lines changed: 26 additions & 1 deletion

File tree

AGENTS.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## 1. Role & Persona
44
You are an expert software engineer specializing in cross-platform development, digital identity security, and scalable backend systems. You write concise, idiomatic, and production-ready code. You prioritize security, performance, and strict adherence to protocol standards. When you don't know something, you say so rather than hallucinating APIs.
55

6-
You should also be familiar with the project's [README.md](README.md) file.
6+
You should also be familiar with the project's [README.md](README.md), [CODING-STYLE.md](CODING-STYLE.md), and [DEVELOPER-MODE.md](DEVELOPER-MODE.md) files.
77

88
## 2. Project Context & Domain
99
* **Domain:** Mobile credential standards, digital identity, and secure wallets.
@@ -56,6 +56,7 @@ The following rules apply when being asked to generate a commit.
5656
* The commit message should detail the changes being committed, not all the prompts that led to here. This includes changes to the source that was done by others, for example the human driving the AI.
5757
* Commit messages must be detailed and to the point. If referring to classes or types in the project enclose it in backticks, if referring to function or method names use trailing open and close parenthesis.
5858
* First line of the commit message must end in a period and be no longer than 72 characters and should avoid using type or function names.
59+
* Commit messages should use line breaks and lines should not be larger than 80 characters, with exceptions to avoid breaking hyperlinks.
5960
* Commit messages must have a "Test:" stanza detailing how the change was tested.
6061
* Commit messages have a Signed-off-by line.
6162

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This repository contains code for the Multipaz Wallet application
77
frontend apps.
88
- `androidApp` is the Android wallet client, using Jetpack Compose.
99
- `iosApp` is the iOS wallet client, using SwiftUI.
10+
- `webApp` is the Web wallet client, using Kotlin/JS, React, and Tailwind CSS (see [webApp/README.md](webApp/README.md)).
1011
- `backend` is the wallet backend.
1112

1213
## What is Multipaz?
@@ -78,6 +79,14 @@ Set wallet backend.
7879
Multipaz Wallet includes a built-in Developer Mode for testing, debugging, and advanced configuration.
7980
For full details on enabling Developer Mode and all available options, see [DEVELOPER-MODE.md](DEVELOPER-MODE.md).
8081

82+
## Running the Android app
83+
84+
To build the Android app debug APK:
85+
```bash
86+
./gradlew :androidApp:assembleDebug
87+
```
88+
You can also open the repository root in Android Studio, select the `androidApp` run configuration, and run it on an emulator or physical device.
89+
8190
## Running the iOS app
8291

8392
To run the iOS app, first you need to build the XCFramework, like this
@@ -93,15 +102,30 @@ You need to do these steps every time code in `shared/` is changed or when updat
93102
Multipaz version. Since building the framework is a time-consuming step (~10 minutes) changes
94103
to `shared/` are normally tested with the Android app, Web App, or unit tests first.
95104

105+
## Running Tests
106+
107+
To run unit and integration tests across the project modules:
108+
109+
- **Shared Core:** `./gradlew :shared:allTests`
110+
- **Backend:** `./gradlew :backend:test`
111+
- **Android App:** `./gradlew :androidApp:testDebugUnitTest`
112+
- **Web App:** `./gradlew :webApp:jsBrowserTest`
113+
- **iOS App:** `xcodebuild -project iosApp/iosApp.xcodeproj -scheme iosApp -sdk iphonesimulator test`
114+
96115
## Contributions
97116

117+
Please follow the coding style guidelines in [CODING-STYLE.md](CODING-STYLE.md).
118+
98119
Commit messages must be detailed and to the point. If referring to classes or types in the
99120
project enclose it in backticks, if referring to function or method names use trailing
100121
open and close parenthesis.
101122

102123
First line of the commit message must end in a period and be no longer than 72 characters
103124
and should avoid using type or function names.
104125

126+
Commit messages should use line breaks and lines should not be larger than 80 characters,
127+
with exceptions to avoid breaking hyperlinks.
128+
105129
Commit messages must have a "Test:" stanza detailing how the change was tested.
106130

107131
Commit messages have a Signed-off-by line.

0 commit comments

Comments
 (0)