https://github.com/rangermauve/telios-mobile
Mobile Telios client using React-Native
https://github.com/rangermauve/telios-mobile
Last synced: 14 days ago
JSON representation
Mobile Telios client using React-Native
- Host: GitHub
- URL: https://github.com/rangermauve/telios-mobile
- Owner: RangerMauve
- License: other
- Created: 2021-10-04T19:59:10.000Z (over 3 years ago)
- Default Branch: default
- Last Pushed: 2021-12-07T23:31:06.000Z (over 3 years ago)
- Last Synced: 2025-03-31T12:57:23.122Z (about 2 months ago)
- Language: JavaScript
- Size: 447 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Telios Mobile
A mobile client for [telios](https://telios.io).
**In Progress**
## Building
- set up node.js 12.19.x (use nvm?)
- set up [node-gyp](https://www.npmjs.com/package/node-gyp) with `npm install -g node-gyp`
- set up react-native and it's dependencies
- `yarn` to install deps
- Android:
- set up Android studio
- Install NDK 21.4 via the SDK manager
- Set up `ANDROID_HOME` environment variable (might be automatic)
- Set up `ANDROID_NDK_HOME` environment variable (should be something like `$ANDROID_HOME/ndk/21.4.7075529`)
- Make sure you have a bunch of RAM on your machine. Might take over 4GB to build the native deps
- iOS:
- Set up XCode 12.4.x
- `sudo gem install cocoapods`
- `pod setup`
- `brew install autoconf automake libtool openssl`
- `cd ios && pod install && cd ../`
- Run `npm run postinstall` to patch modules and install the nodejs-mobile dependencies
Run either `yarn android` or `yarn ios` to run on the respective platforms. iOS only works on Macs and you need to register your phone for signing in xcode first. As well, only the release version of Android seems to be working at the moment. Something gets messed up with the bridge.
## How it works:
- Uses [nodejs-mobile-react-native](https://github.com/nodejs-mobile/nodejs-mobile-react-native) in order to run node.js code on mobile (telios/nebula-drive) Code can be found in `nodejs-assets/nodejs-project/`. Communicates to the React-Native thread via a "bridge" that can pass JSON messages
- (npm run postinstall)
- Modify `node_modules/nodejs-mobile-react-native/android/build.gradle` to remove `main {}` according to [this post](https://github.com/JaneaSystems/nodejs-mobile/issues/317#issuecomment-852033823)
- Apply this patch for EventEmitter import after installing: https://github.com/JaneaSystems/nodejs-mobile-react-native/pull/20/files
- Apply these fixes to metro.config.js (different from the current README since APIs changed) https://github.com/JaneaSystems/nodejs-mobile/issues/314#issuecomment-832491168
- Set up arm ABIs in the build.gradle since they're missing in the default react-native gradle script
- Monkey-patch Hypercore.defaultStorage to disable the `lock` functionality on `oplog` files since this doesn't seem to work on Android
- Patch `sodium-native` and `utp-native` to point at `sodium-native-nodejs-mobile` and `utp-native-nodejs-mobile` in order to compile they for mobile
- Add scripts to build that do the following:
- Before building native nodejs libraries, clear some duplicate modules and monkey-patch sodium-native and utp-native to point at their nodejs-mobile variants
- After building compile all the JS into a single `bundle.js` file starting with `main.js`
- ON ANDROID: copy the libsodium.la files inside `sodium-native-nodejs-mobile/lib` to `android/app/src/jniLibs`
- Clear out any unnecessary `node_modules` or files to reduce app size and improve startup
## Debugging
- Make sure you're using the correct version of node.js and NDK/XCode
- Try clearing node_modules and installing them again
- If using android, try clearing `android/app/build`
- Try running the app from within Android Studio or XCode
- Use `console.trace` inside the node_modules to track stuff down inside nodejs-mobile threads