nym/README.md

The Nym Privacy Platform

This repository contains the full Nym platform, written in Rust.

The platform is composed of multiple Rust crates. Top-level crates include:

• client - an executable crate which you can use for interacting with Nym nodes
• mixnode - an executable mixnode crate
• sfw-provider - an executable store-and-forward provider crate. The provider acts sort of like a mailbox for mixnet messages.

Building

Platform build instructions are available on our docs site.

Developing

There's a .env.sample-dev file provided which you can rename to .env if you want convenient logging, backtrace, or other environment variables pre-set. The .env file is ignored so you don't need to worry about checking it in.