aljaz/pear-docs
1
0
Fork 0
mirror of https://github.com/aljazceru/pear-docs.git synced 2025-12-17 22:44:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add Mobile Application Guide (#167)

Browse Source 
* Add "Making a Bare Mobile App" guide

* Change title to be 'Application' instead of 'App' in mobile guide

* Pin `autopass` to `1.x.x` in mobile guide

* Update "Bare on Mobile" to point readers to the mobile guide

* Add Bare mobile application guide to README.md

* Tweak wording in "Bare on Mobile"

* Remove "Cross-platform Pear App" example

This example app has been archived and is now outdated.

* Add missing link in SUMMARY.md for mobile guide

* Update mobile app guide to use new worklet api & support autopass@2.1
This commit is contained in:
Sean Zellmer
2025-03-18 02:54:42 -05:00
committed by GitHub
parent e8cd9cc6e5
commit 5800a7031f
6 changed files with 394 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
examples/bare-on-mobile.md
View File

@@ -2,7 +2,7 @@
Bare can be embedded into mobile applications to serve as the "Pear-end" where the peer-to-peer code of the application is run.
To get started with embedding [Bare](../reference/bare/overview.md) into an [Expo](https://expo.dev/) mobile application use the [Bare on Expo](https://github.com/holepunchto/bare-expo) example as reference. This example integrates Bare as an isolated thread, called a worklet[^1], via [`react-native-bare-kit`](https://github.com/holepunchto/react-native-bare-kit). All code passed when starting the worklet will run in the Bare runtime and can be communicated with via an inter-process communication (IPC) stream.
To get started with [Bare](../reference/bare/overview.md) mobile development via [Expo](https://expo.dev/), check out the ["Making a Bare Mobile Application" guide](../guide/making-a-bare-mobile-app.md). It uses the [Bare on Expo](https://github.com/holepunchto/bare-expo) template to build a mobile app for syncing passwords with the [Pearpass desktop example](https://github.com/holepunchto/pearpass-example). This example integrates Bare as an isolated thread, called a worklet[^1], via [`react-native-bare-kit`](https://github.com/holepunchto/react-native-bare-kit). All code passed when starting the worklet will run in the Bare runtime and can be communicated with via an inter-process communication (IPC) stream.
[^1]: This term was chosen to avoid ambiguity with worker threads as implemented by <https://github.com/holepunchto/bare-worker>.

9
examples/cross-platform-pear-app.md
View File

@@ -1,9 +0,0 @@
# Cross-platform Pear App
A "Hello World" example of a cross-platform Pear application for Android and iOS using [Bare](https://github.com/holepunchto/bare) and [Expo SDK](https://expo.dev/).
- [Pear Expo Hello World](https://github.com/holepunchto/pear-expo-hello-world)
> This above example is still a work in progress, please expect further improvements.
Note that on mobile, the React Native UI runs on one thread and the Bare local backend runs on another thread and they both communicate via an IPC API.