8
0

update README.md with Android setup instructions

This commit is contained in:
andre 2026-02-16 11:01:40 +01:00
parent 24f733af70
commit 9839ea5650

View File

@ -2,21 +2,70 @@
> **Disclaimer**
>
> This repository contains a proof-of-concept React Native plugin and an example mobile application intended solely for technical evaluation.
> This repository contains a proof-of-concept React Native plugin and an example mobile application intended solely for technical evaluation.
>
> Only the iOS integration has been verified to work at this time.
> The Android bridge and Android example setup exist but have not been tested and are expected to require additional adjustments before they can be considered functional.
>
> This repository is **experimental**, **not formally approved**, **not officially released**, **not published as an npm package**, and **not endorsed by WebID for
> This repository is **experimental**, **not formally approved**, **not officially released**, **not published as an npm package**, and **not endorsed by WebID for
> production use**.
>
> The setup described below includes non-standard workarounds and temporary configuration adjustments that are required due to current
> The setup described below includes non-standard workarounds and temporary configuration adjustments that are required due to current
> tooling and dependency constraints.
---
# Android
_Android instructions will be added in a future commit._
## Prerequisites
- React Native version must be compatible with Kotlin 2.1
(Your host app + Gradle + Kotlin versions must match. If the native module uses Kotlin 2.1, the app must not force an incompatible Kotlin version.)
- Java 17
- Android Studio (includes Android SDK + Platform Tools / adb)
## Running the example app (iOS)
### Create and Configure the `.env` File
Navigate to the example project and create the environment file:
```
cd example
cp .env.example .env
```
### Example:
```
URL=https://test.webid-solutions.de
USERNAME=your_username
API_KEY=your_api_key
CERT_BASE64=your_cert_base64
# optional (only if your JS/native side uses sha pins directly)
# SHA_PINS=sha256/AAAA...,sha256/BBBB...
```
Edit the .env file and add your username and API key.
### Install Dependencies
From the repository root:
```
yarn install
```
### Running the App
Then navigate to the iOS example project:
```
cd example/android
yarn start
```
In a second terminal:
```
cd example
yarn android
```
# iOS