Dave Hrycyszyn
f6a79ce7c3
* Renaming validator-api to nym-api * nym-api: simplified crate name * Added nym-api rename to changelog * Changed some output messages * Renamed validator-api-requests to nym-api requests * Removing more references to validator-api-requests * Additional lockfile name changes after full build * Removing mistakenly added merge files * ibid * ibid * Getting rid of ref to validator_api deep inside validator-client * Fixing file storage paths * Renaming struct function names referring to validator_api * Simplifying struct init * Fixed up all other instances of nym_api. * Renaming validatorApi to nymApi in TypeScript client for consistency v * Found a few more Rust instances * Changed examples in TypeScript SDK * Found one more instance of the use of validator instead of nym apis * Aliasing config key name for deserialization to preserve compatibility with old configs
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