Files
nym/nym-connect/mobile
Fouad fcc5398aab Feature/node tester package (#3634)
* create node tester package dir

* start building node tester package

* refactor code + build updates

* fix up types

* add more methods and fix up types

* use node tester sdk inside wallet

* fix frontend state

* Use Node 18 instead of 16

* Fix up dependencies and yarn workspace

* Fix lint error

* Try to fix up linting error

* Remove explorer linting and move it to the existing action

* Add wasm-pack build to linting GH Action

* change lerna to use workspaces and fix linting errors

* Fix up node versions in GitHub Actions and add wasm-pack

* fix build:lint target in sdk

* exclude all worker.js from eslint for sdk

---------

Co-authored-by: Mark Sinclair <mmsinclair@users.noreply.github.com>
2023-07-03 16:53:39 +01:00
..
2023-07-03 16:53:39 +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