newtmex / nym-localnet

A docker config for setting up a local environment for developing PEApps on Nym

Welcome to Nym Localnet: Empowering PEApps with Local Nym Infrastructure

Overview

Nym Localnet is your go-to solution for setting up a local Nym infrastructure, providing all the essential components needed for Privacy-Enhanced Application (PEApp) development. Say goodbye to testing on public networks—Nym Localnet empowers developers to create and test their PEApps on a secure local environment.

Key Features

1. Local Nyx Chain

• Nym Localnet establishes a local Nyx chain, ensuring developers have a dedicated and controlled environment to test their applications.

2. Local Nym Mixnet

• Test the privacy features of your PEApps by integrating with a local Nym Mixnet, allowing for seamless communication in a secure and private manner.

3. Nym Gateway

• Easily set up a local Nym Gateway as a bridge between your PEApps and the Nym Mixnet. Ensure your applications communicate with the mixnet efficiently.

4. Developer-Friendly Testing

• Develop and test your PEApps on the local infrastructure, providing a safe space to iterate and experiment without impacting or being restricted by the public mainnet or sandbox.

Getting Started

1. Installation

   TODO

2. Configuration

   TODO

3. PEApp Integration

   TODO

Community Support

Join the vibrant community of Nym developers. Need assistance or have insights to share? Visit the Community Forum and become an integral part of the conversation.

Reporting Issues

Encountered a bug or have suggestions for improvement? Head over to our GitHub Issue Tracker to report and discuss.

Contribute

Please follow the project's contributing guidlines.

License

Nym Localnet is released under the MIT License. Feel free to adapt, modify, and distribute it to suit your PEApp development needs.