Pierre Dommerc
3e6188ed13
* feat(nym-connect): add android support * fix(nym-connect): android linker issue with sqlite3 get rid of sqlite refs as temporary workaround * fix(nc): fix index.ts (post rebase) * feat(nc-android): wip * hack in config removal of read/write * fix(nc-android): remove more fs read/write calls * wip * chore: remove debug comments * Register gateway * client-core: remove unneeded changes * build: revert crate name change * refactor(socks5-client): add feature mobile * refactor(gateway-client): rename mobile feature * socks5: restore default_root_directory * client-core: further simplifications * get_config_file_location just return error * fix(nc-mobile): fix ui mobile * socks5: minor tweak to default_root_directory * remove unneeded changes * nym-connect build fixes * Use default feature for normal credential storage * rustfmt * rustfmt: nym-connect * restore Cargo.toml * Remove --all-features from workflow * Remove some unused use * Remove two move --all-features from build workflow * Allow unused * Add continue-on-error * another clippy --all-features remove * remove --all-features from clippy nightly * fix(nc-mobile): frontend code errors * feat: restore nc, move mobile under its own dir * fix(nc-android): build * fix(nc-android): lint errors Co-authored-by: Jon Häggblad <jon.haggblad@gmail.com>
Nym Connect
Nym is an open-source, decentralized and permissionless privacy system. It provides full-stack privacy, allowing other applications, services or blockchains to provide their users with strong metadata protection, at both the network level (mixnet), and the application level (anonymous credentials) without the need to build privacy from scratch.
Nym Connects sets up a SOCKS5 proxy for local applications to use.
Installation prerequisites - Linux / Mac
YarnNodeJS >= v16Rust & cargo
Installation prerequisites - Windows
- When running on Windows you will need to install c++ build tools
- An easy guide to get rust up and running Installation
- When installing NodeJS please use the
current featuresversion - Using a package manager like Chocolatey is recommended
- Nym connect requires you to have
Webview2installed, please head to the Installer, this will ensure a smooth app launch
Installation
Inside the nym-connect directory, run the following command:
yarn install
Development mode
You can compile nym-connect in development mode by running the following command inside the nym-connect directory:
yarn dev
This will produce a binary in - nym-connect/target/debug/ named nym-connect
To launch, navigate to the directory and run the following command: ./nym-connect
Production mode
Run the following command from the nym-connect folder
yarn build
The output will compile different types of binaries dependent on your hardware / OS system. Once the binaries are built, they can be located as follows:
Binary output directory structure
**macos**
|
└─── target/release
| |─ nym-connect
└───target/release/bundle/dmg
│ │─ bundle_dmg.sh
│ │─ nym-connect.*.dmg
└───target/release/bundle/macos/MacOs
│ │─ nym-connect
|
**Linux**
└─── target/release
| │─ nym-connect
└───target/release/bundle/appimage
│ │─ nym-connect_*_.AppImage
│ │─ build_appimage.sh
└───target/release/bundle/deb
│ │─ nym-connect_*_.deb
|
**Windows**
└─── target/release
| │─ nym-connect.exe
└───target/release/bundle/msi
│ │─ nym-connect_*_.msi
For instructions on how to release nym-connect, please see RELEASE.md.
Storybook
Run storybook with:
yarn storybook
And build storybook static site with:
yarn storybook:build