Skip to content

Commit

Permalink
docs: developer doc update (#2231)
Browse files Browse the repository at this point in the history
Signed-off-by: al-rosenthal <[email protected]>
  • Loading branch information
al-rosenthal authored Oct 25, 2024
1 parent 2a7c6f3 commit 3bbdd15
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 3 deletions.
21 changes: 18 additions & 3 deletions DEVELOPER.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ To work on changes to BC Wallet in Bifold (the underlying Aries project) you wil

```sh
# from bc-wallet-mobile
git clone [email protected]:hyperledger/aries-mobile-agent-react-native.git bifold
git clone [email protected]:hyperledger/aries-mobile-agent-react-native.git bifold
```

```sh
Expand Down Expand Up @@ -97,15 +97,16 @@ Then once your PR is merged and the packages have been published, make a PR in b
In the `./app/` directory copy the .env.sample `cp .env.sample .env`

```
MEDIATOR_URL=<url>
LOAD_STORYBOOK=false
OCA_URL=<url>
MEDIATOR_URL=<url>
MEDIATOR_USE_PUSH_NOTIFICATIONS=false
PROOF_TEMPLATE_URL=<url>
REMOTE_LOGGING_URL=<url>
INDY_VDR_PROXY_URL=<url>
```

Push notifications can be used locally if the mediator service has the firebase plugin and it's configured correctly.
Push notifications can be used locally if the mediator service has the firebase plugin and it's configured correctly.

### Adding ledger configurations

Expand Down Expand Up @@ -230,6 +231,20 @@ Note: You may have to reboot your emulator once this is complete for it to take
Now, to add any image to the virtual scene (an image of a QR code for example), simply place the image file in this directory with the name `custom.png`
### Adding QR code to emulator camera view (Extended controls)
Another method for adding images to an emulated android device is through the extended controls panel
To place a QR code into the emulators camera view, you'll first need open android studio and create a new virtual device. Once the virtual device is created, start it. In the running Devices tab, look for a kebob menu in the tray (photo below), this is the extended controls menu.

![Extended controls menu](/docs/extended-controls-kebob.png)

when that menu opens, navigate to the Camera section, there you'll see two options for adding an image, the wall and the table. Add the image of the QR code you'd like to scan and close the menu.

Once inside the app, open the QR scanning screen, you'll be dropped into a virtual scene where you'll be able to navigate around and find the QR code to scan.
To move around: hold `shift` + (`W`,`A`,`S`,`D`)
To look around: use the arrow keys

## Troubleshooting and debugging

### Hot reloading
Expand Down
1 change: 1 addition & 0 deletions app/.env.sample
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
OCA_URL=https://raw.githubusercontent.com/bcgov/aries-oca-bundles/main/
MEDIATOR_URL=https://f326-207-194-65-204.ngrok.io?c_i=eyJAdHlwZSI6ICJodHRwczovL2RpZGNvbW0ub3JnL2Nvbm5lY3Rpb25zLzEuMC9pbnZpdGF0aW9uIiwgIkBpZCI6ICI2MjQ0ZThiNS0wNWYzLTRhYWItYjM1Yy1lYWVlMWNmZTAyM2MiLCAicmVjaXBpZW50S2V5cyI6IFsiQ3lqM1BHRUJzQ3RyUGFtTTQyRngza3BlYmR2QWdNd1lGejlFS3RmNnlUN3giXSwgImxhYmVsIjogIk1lZGlhdG9yIiwgInNlcnZpY2VFbmRwb2ludCI6ICJodHRwczovL2YzMjYtMjA3LTE5NC02NS0yMDQubmdyb2suaW8ifQ==
MEDIATOR_USE_PUSH_NOTIFICATIONS=false
LOAD_STORYBOOK=false
PROOF_TEMPLATE_URL=
REMOTE_LOGGING_URL=
INDY_VDR_PROXY_URL=
Binary file added docs/extended-controls-kebob.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3bbdd15

Please sign in to comment.