Files
nym/nym-connect/mobile
Jędrzej Stuczyński 9a68702d4d Feature/config refactor (#3498)
* revamping mixnode connfig

* wip

* native client config revamping

* wip

* building socks5

* using const for mixnnode config template

* compiling updated gateway

* nym-api

* nym-sdk

* everything compiling once more

but definitely not compatible with CI and older versions (yet)

* creating full directory structure on init

* renamed paths to storage_paths and fixed mixnode template

* mixnode config migration

* gateway config migration

* nym-api config migration

* native client config migration

* socks5 client config migration

* NR config migration

* removed deprecations (that will be resolved in the following PRs) + fixed clippy

* nym-connect clippy

* nym-connect config updates

* outfox fixes

* defined socks5 lib config

* clippy

* fixed wasm client build

* removed explicit packet_type argument when starting base client

it's known implicitly from the previously passed config struct

* Empty commit

* fixed re-using gateway information when client configs are re-initialised

* fixed borrowing id value in nym-connect

* post-rebase fixes

* updated 'old_config' versions

---------

Co-authored-by: Tommy Verrall <tommy@nymtech.net>
2023-06-07 17:06:35 +01:00
..
2023-06-07 17:06:35 +01:00

Nym Connect - Mobile

Nym Connect application for Mobile.

Nym Connects sets up a SOCKS5 proxy for local applications to use.

NOTE: Currently we only focus on Android, the remaining docs apply for Android development only.

Installation prerequisites - Linux / Mac

  • Yarn
  • NodeJS >= v16
  • Rust & cargo
  • Android development environment (JDK, SDK/NDK, AVD etc...)

For setting up an Android development environment see https://next--tauri.netlify.app/next/guides/getting-started/prerequisites/linux#android

Installation

Inside the mobile/nym-connect directory, run the following commands:

yarn install
yarn prewebpack:dev

Development

Assuming there is a running android emulator or a real device connected. Inside the mobile/nym-connect/src-tauri directory, run the following command:

yarn dev:android

Debugging

https://next--tauri.netlify.app/next/guides/debugging/application#mobile

Production

To build the APK, run the build commands.

yarn webpack:prod
WRY_ANDROID_PACKAGE=net.nymtech.nym_connect WRY_ANDROID_LIBRARY=nym_connect cargo tauri android build --debug --apk

NOTE: Production build without the --debug flag requires a signed build.

Storybook

Run storybook with:

yarn storybook

And build storybook static site with:

yarn storybook:build