Update README.md
Some checks failed
CI / lint (push) Has been cancelled
CI / test (push) Has been cancelled
CI / build-library (push) Has been cancelled
CI / build-android (push) Has been cancelled
CI / build-ios (push) Has been cancelled
Some checks failed
CI / lint (push) Has been cancelled
CI / test (push) Has been cancelled
CI / build-library (push) Has been cancelled
CI / build-android (push) Has been cancelled
CI / build-ios (push) Has been cancelled
This commit is contained in:
parent
bb2968e943
commit
854dfef197
33
README.md
33
README.md
@ -2,9 +2,12 @@
|
|||||||
|
|
||||||
> **Disclaimer**
|
> **Disclaimer**
|
||||||
>
|
>
|
||||||
> This repository contains an example iOS application and React Native plugin integration provided solely as a proof of concept and for
|
> This repository contains a proof-of-concept React Native plugin and an example mobile application intended solely for technical evaluation.
|
||||||
> technical evaluation.
|
>
|
||||||
> It is **experimental**, **not formally approved**, **not officially released**, **not published as an npm package**, and **not endorsed by WebID for
|
> 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
|
||||||
> production use**.
|
> 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
|
||||||
@ -12,18 +15,10 @@
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Overview
|
# Android
|
||||||
|
_Android instructions will be added in a future commit._
|
||||||
|
|
||||||
This repository contains an example iOS application demonstrating integration of the **WebID Meta Plugin** in a React Native environment.
|
# iOS
|
||||||
|
|
||||||
Due to:
|
|
||||||
- mixed minimum iOS deployment targets,
|
|
||||||
- vendored dynamic XCFrameworks,
|
|
||||||
- React Native / CocoaPods integration constraints,
|
|
||||||
|
|
||||||
additional manual steps are currently required to successfully build and run the app.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
@ -34,7 +29,7 @@ additional manual steps are currently required to successfully build and run the
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Running the example app
|
## Running the example app (iOS)
|
||||||
|
|
||||||
### Create and Configure the `.env` File
|
### Create and Configure the `.env` File
|
||||||
|
|
||||||
@ -50,7 +45,7 @@ Edit the .env file and add your username and API key.
|
|||||||
ℹ️ The provided CERT_BASE64 value is preconfigured for the test system and is valid until 2026-02-21.
|
ℹ️ The provided CERT_BASE64 value is preconfigured for the test system and is valid until 2026-02-21.
|
||||||
In most cases, this value does not need to be modified if you intend to test against the test environment.
|
In most cases, this value does not need to be modified if you intend to test against the test environment.
|
||||||
|
|
||||||
### Install dependencies
|
### Install Dependencies
|
||||||
|
|
||||||
From the repository root:
|
From the repository root:
|
||||||
|
|
||||||
@ -60,7 +55,7 @@ yarn install
|
|||||||
|
|
||||||
This is required to install JavaScript dependencies and must be run before installing iOS pods or running the example app.
|
This is required to install JavaScript dependencies and must be run before installing iOS pods or running the example app.
|
||||||
|
|
||||||
### Install pods
|
### Install Pods
|
||||||
|
|
||||||
|
|
||||||
Navigate to the iOS example project:
|
Navigate to the iOS example project:
|
||||||
@ -133,7 +128,7 @@ cd example/ios
|
|||||||
yarn ios
|
yarn ios
|
||||||
```
|
```
|
||||||
|
|
||||||
or run ```yarn start``` from the example dir.
|
or run `yarn start` from the example dir.
|
||||||
Note: If you adjust the values in the .env file, you might need to run yarn start --reset-cache in order for these changes to be applied!
|
Note: If you adjust the values in the .env file, you might need to run yarn start --reset-cache in order for these changes to be applied!
|
||||||
|
|
||||||
## Core files to inspect:
|
## Core files to inspect:
|
||||||
@ -144,4 +139,4 @@ Note: If you adjust the values in the .env file, you might need to run yarn star
|
|||||||
|
|
||||||
## Additional notes
|
## Additional notes
|
||||||
|
|
||||||
When the example Xcode project was setup initially, all WebID libraries aswell as the transitive AhoyKit depedency had to be manually embedded as frameworks under Targets -> Frameworks, Libraries and Embedded Content. In a Cocoapods setup, this should usually **not** be necessary as it should be handlded by the "[CP] Embed Pods Frameworks" build phase. But in this case, the app always crashed because required dynamic libraries where missing when not adding them manually.
|
When the example Xcode project was set up initially, all WebID libraries as well as the transitive AhoyKit dependency had to be manually embedded as frameworks under Targets → Frameworks, Libraries and Embedded Content. In a CocoaPods setup, this should usually not be necessary, as it should be handled by the “[CP] Embed Pods Frameworks” build phase. However, in this case, the app always crashed because required dynamic libraries were missing when not adding them manually.
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user