Files
nym/nym-connect/mobile/README.md
T
Pierre Dommerc ae56d3685c refactor(nym-connect): new file structure (#3082)
* refactor(nc-android): move nc android into mobile/nym-connect

rename the android app ID to "nym_connect"

* chore(nc-mobile): restore dist directory

* fix: typo

* chore: restore gitkeep

* chore: track Cargo.lock

* ci: trigger ts lint workflow on pull request

* refactor(nym-connect): new structure

move temp mobile version under nym-connect-new/mobile

* refactor(nym-connect): new structure

move temp desktop version under nym-connect-new/desktop

* refactor(nym-connect): new structure

rename nym-connect-new to nym-connect

* refactor(nym-connect): new structure

restore lost .gitkeep

* refactor(nym-connect): new structure

restore lost .gitkeep

* fix(nym-connect-desktop): broken relative paths

* fix(nym-connect-mobile): add todo comment about broken deps

* ci(nym-connect): fix relative paths

* ci(nym-connect): rename workflow
2023-02-22 17:01:46 +01:00

1.5 KiB

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

Storybook

Run storybook with:

yarn storybook

And build storybook static site with:

yarn storybook:build