diff --git a/documentation/dev-portal/src/SUMMARY.md b/documentation/dev-portal/src/SUMMARY.md index be35e9c30a..aeae804662 100644 --- a/documentation/dev-portal/src/SUMMARY.md +++ b/documentation/dev-portal/src/SUMMARY.md @@ -40,8 +40,7 @@ # Community Resources - [Nym DevRel AMAs](community-resources/ama.md) -- [Community Applications](community-resources/community-applications.md) -- [Community Guides](community-resources/community-guides.md) +- [Community Applications and Guides](community-resources/community-applications-and-guides.md) - [Change Service Grantee Information](info-request.md) - [Rewards FAQ](community-resources/rewards-faq.md) --- diff --git a/documentation/dev-portal/src/community-resources/community-applications-and-guides.md b/documentation/dev-portal/src/community-resources/community-applications-and-guides.md new file mode 100644 index 0000000000..ba00922658 --- /dev/null +++ b/documentation/dev-portal/src/community-resources/community-applications-and-guides.md @@ -0,0 +1,116 @@ +# Community Applications + +We love seeing our developer community create applications using Nym. If you would like to share your application with the community, please submit a pull request to the `main` branch of the `nymtech/dev-portal` [repository](https://github.com/nymtech/dev-portal). + + + +## Pastenym + +>A [pastebin](https://pastebin.com) inspired project, offer a solution for sharing text with Nym products to offer full anonymity, even on metadata level. + +* [Github](https://github.com/notrustverify/pastenym) +* [Deployed App](https://pastenym.ch) + + + + +## Nostr-Nym + +> [Nostr-nym](https://github.com/notrustverify/nostr-nym) offer a solution to use [Nostr](https://nostr.how/en/what-is-nostr) protocol by giving the possibility to run a relay on mixnet. By using a nostr client compatible with the mixnet, users can protect their privacy to be able to use Nostr has the want, without being observed. + +* [Github](https://github.com/notrustverify/nostr-nym) +* [Deployed App](https://nostrnym.pnproxy.org/) +* [Documentation](https://blog.notrustverify.ch/nostr-relay-on-nym) + + + + +## Spook + +> Ethereum RPC request mixer uses the Nym network mixing service to anonymize RPC requests to the Ethereum network without revealing sensitive data and metadata. +* [Github](https://github.com/EdenBlockVC/spook) + + + + +## Ethereum Transaction Broadcaster + +> Ethereum Transaction Broadcaster that uses the Nym Mixnet to provide privacy and anonymity for transactions on the Ethereum network command-line interface. + +* [Github](https://github.com/noot/nym-ethtx) + + + + +## NymDrive + +> An open-source, decentralized, E2E encrypted, privacy friendly alternative to Google Drive/Dropbox, allowing for file encryption and decryption using the Nym Mixnet. +* [Github](https://github.com/saleel/nymdrive) +* [Demo](https://www.youtube.com/watch?v=5Rx73nw8NYI) +* [Presentation](https://docs.google.com/presentation/d/1MpvIK32Mx9VKLVfMTcvbeyrsKHHUsTvDQ-3n31dR0NE/edit#slide=id.p) + + + + +## Nym Dashboard + +> Developed by No Trust Verify, this dashboard is a great tool to get information about the mixnet, gateways and mixnodes. +* [Deployed App](https://status.notrustverify.ch/d/CW3L7dVVk/nym-mixnet?orgId=1) + + + + +## Is Nym Up + +> Explore whether we're up through IsNymUp, a tool that helps check the heath of the Nym network as well as some mixnet related statistics! +* [Deployed App](https://isnymup.com/) + + + + +## DarkFi over Nym + +> DarkFi leverages Nym's mixnet as a pluggable transport for IRCD, their p2p IRC variant. Users can anonymously connect to peers over the network, ensuring secure and private communication within the DarkFi ecosystem. +* [Github](https://github.com/darkrenaissance/darkfi) +* [Documentation](https://darkrenaissance.github.io/darkfi/clients/nym_outbound.html) + + + + +## Nymstr email + +> Experience secure and private email communication with ease using Nymstr email, which enables seamless transmission of emails over a SOCKS5 proxy and our NYM mixnet! +* [Github](https://github.com/dial0ut/nymstr-email) + + + + +## Minibolt + +> Anonymize your p2p inventory messages and mempool for your Bitcoin & Lightning full nodes on consumer PCs! +* [Github](https://github.com/minibolt-guide/minibolt) +* [Documentation](https://v2.minibolt.info/bonus-guides/system/nym-mixnet#proxying-bitcoin-core) + + + +

+ +# Community Guides + +We aren't the only ones writing documentation: the Nym developer community is also a great source of guides and resources, some of which we've included here. + +## No Trust Verify + +>No Trust Verify is a project that aims to build open-source, privacy-enhancing technologies that make it easier to use the Internet securely and anonymously. Their focus is on providing tools and services that make it simple for developers to create decentralized applications (dApps) that respect users' privacy. + +* [Awesome Nym list](https://notrustverify.github.io/awesome-nym/) ([GitHub](https://github.com/notrustverify/awesome-nym)) +* A lot of guides can be found on the [NTV Blog](https://blog.notrustverify.ch/) + + +## The Way of the NYMJA + +by Pineapple Proxy🍍 + +>Born out of a study group from Nym's Shipyard Academy, Pineapple Proxy has emerged as a cluster of motivated and skilled individuals who see the new internet taking shape. With vibecare at the heart of their approach, this zesty collective is on a mission to make privacy convenient for everyone via content, new tools, events, and novel experiences. They believe in collective intelligence, empathy, and collaboration as the means by which privacy will become a meaningful reality. +* [Website](https://pnproxy.org/welcome.html) ([GitHub](https://github.com/Pineapple-Proxy-DAO/web)) + diff --git a/documentation/dev-portal/src/community-resources/community-applications.md b/documentation/dev-portal/src/community-resources/community-applications.md deleted file mode 100644 index 9eada01337..0000000000 --- a/documentation/dev-portal/src/community-resources/community-applications.md +++ /dev/null @@ -1,61 +0,0 @@ -# Community Applications - -We love seeing our developer community create applications using Nym. If you would like to share your application with the community, please submit a pull request to the `main` branch of the `nymtech/dev-portal` [repository](https://github.com/nymtech/dev-portal). - - - -## Pastenym - ->A [pastebin](https://pastebin.com) inspired project, offer a solution for sharing text with Nym products to offer full anonymity, even on metadata level. - -* [Github](https://github.com/notrustverify/pastenym) -* [Deployed Website App](https://pastenym.ch) - - - - - -## Nostr-Nym - -> [Nostr-nym](https://github.com/notrustverify/nostr-nym) offer a solution to use [Nostr](https://nostr.how/) protocol by giving the possibility to run a relay on mixnet. By using a nostr client compatible with the mixnet, users can protect their privacy to be able to use Nostr has the want, without being observed. - -* [Github](https://github.com/notrustverify/nostr-nym) -* Deployed Website App coming soon - - - - - - -## Spook - -> Ethereum RPC request mixer uses the Nym network mixing service to anonymize RPC requests to the Ethereum network without revealing sensitive data and metadata. -* [Github](https://github.com/EdenBlockVC/spook) - - - - - -## Ethereum Transaction Broadcaster - -> Ethereum Transaction Broadcaster that uses the Nym Mixnet to provide privacy and anonymity for transactions on the Ethereum network command-line interface. - -* [Github](https://github.com/noot/nym-ethtx) - - - - - -## NymDrive - -> An open-source, decentralized, E2E encrypted, privacy friendly alternative to Google Drive/Dropbox, allowing for file encryption and decryption using the Nym Mixnet. -* [Github](https://github.com/saleel/nymdrive) -* [Demo](https://www.youtube.com/watch?v=5Rx73nw8NYI) -* [Presentation](https://docs.google.com/presentation/d/1MpvIK32Mx9VKLVfMTcvbeyrsKHHUsTvDQ-3n31dR0NE/edit#slide=id.p) - - - - - - - diff --git a/documentation/dev-portal/src/community-resources/community-guides.md b/documentation/dev-portal/src/community-resources/community-guides.md deleted file mode 100644 index 7a5973f6f2..0000000000 --- a/documentation/dev-portal/src/community-resources/community-guides.md +++ /dev/null @@ -1,17 +0,0 @@ -# Community Guides - -We aren't the only ones writing documentation: the Nym developer community is also a great source of guides and resources, some of which we've included here. - -## No Trust Verify - ->No Trust Verify is a project that aims to build open-source, privacy-enhancing technologies that make it easier to use the Internet securely and anonymously. Their focus is on providing tools and services that make it simple for developers to create decentralized applications (dApps) that respect users' privacy. - -* [Awesome Nym list](https://notrustverify.github.io/awesome-nym/) ([GitHub](https://github.com/notrustverify/awesome-nym)) -* A lot of guides can be found on the [NTV Blog](https://blog.notrustverify.ch/) - -## The Way of the NYMJA - -by Pineapple Proxy🍍 - ->Born out of a study group from Nym's Shipyard Academy, Pineapple Proxy has emerged as a cluster of motivated and skilled individuals who see the new internet taking shape. With vibecare at the heart of their approach, this zesty collective is on a mission to make privacy convenient for everyone via content, new tools, events, and novel experiences. They believe in collective intelligence, empathy, and collaboration as the means by which privacy will become a meaningful reality. -* [Website](https://pnproxy.org/welcome.html) ([GitHub](https://github.com/Pineapple-Proxy-DAO/web)) diff --git a/documentation/dev-portal/src/images/profile_picture/darkfi_over_nym_pp.png b/documentation/dev-portal/src/images/profile_picture/darkfi_over_nym_pp.png new file mode 100644 index 0000000000..9ae44d85c1 Binary files /dev/null and b/documentation/dev-portal/src/images/profile_picture/darkfi_over_nym_pp.png differ diff --git a/documentation/dev-portal/src/images/profile_picture/minibolt_pp.png b/documentation/dev-portal/src/images/profile_picture/minibolt_pp.png new file mode 100644 index 0000000000..ed059e6055 Binary files /dev/null and b/documentation/dev-portal/src/images/profile_picture/minibolt_pp.png differ diff --git a/documentation/dev-portal/src/images/profile_picture/nym_dashboard_pp.svg b/documentation/dev-portal/src/images/profile_picture/nym_dashboard_pp.svg new file mode 100644 index 0000000000..e91f3abdb4 --- /dev/null +++ b/documentation/dev-portal/src/images/profile_picture/nym_dashboard_pp.svg @@ -0,0 +1,57 @@ + + + + + + + + + + + + diff --git a/documentation/dev-portal/src/images/profile_picture/nymstr_email_pp.png b/documentation/dev-portal/src/images/profile_picture/nymstr_email_pp.png new file mode 100644 index 0000000000..404b9e2529 Binary files /dev/null and b/documentation/dev-portal/src/images/profile_picture/nymstr_email_pp.png differ diff --git a/documentation/dev-portal/src/integrations/mixnet-integration.md b/documentation/dev-portal/src/integrations/mixnet-integration.md index 43fea3e7e9..e4a328bf24 100644 --- a/documentation/dev-portal/src/integrations/mixnet-integration.md +++ b/documentation/dev-portal/src/integrations/mixnet-integration.md @@ -36,7 +36,7 @@ In order to ensure uptime and reliability, it is recommended that you run some p * If you're running a purely P2P application, then just integrating clients and having some method of sharing addresses should be enough to route your traffic through the mixnet. * If you're wanting to place the mixnet between your users' application instances and a server-based backend, you can use the [network requester](https://nymtech.net/docs/nodes/network-requester-setup.html) service provider binary to proxy these requests to your application backend, with the mixnet 'between' the user and your service, in order to prevent metadata leakage being broadcast to the internet. -* If you're wanting to route RPC requests through the mixnet to a blockchain, you will need to look into setting up some sort of service that does the transaction broadcasting for you. You can find examples of such projects on the [community applications](../community-resources/community-applications.md) page. +* If you're wanting to route RPC requests through the mixnet to a blockchain, you will need to look into setting up some sort of service that does the transaction broadcasting for you. You can find examples of such projects on the [community applications](../community-resources/community-applications-and-guides.md) page. ## Example application traffic flow ### Initialization diff --git a/documentation/dev-portal/src/quickstart/overview.md b/documentation/dev-portal/src/quickstart/overview.md index a9586172ed..b2ac4199c9 100644 --- a/documentation/dev-portal/src/quickstart/overview.md +++ b/documentation/dev-portal/src/quickstart/overview.md @@ -2,9 +2,10 @@ There are multiple options to quickly connect to Nym and see the network in action without the need for any code changes to your application. At most, these involve running Nym as a second process alongside an existing application in order to send traffic through the mixnet. -Demo application: +Demo applications: * a browser-based 'hello world' [chat application](https://chat-demo.nymtech.net). Either open in two browser windows and send messages to yourself, or share with a friend and send messages to each other through the mixnet! - +* a Coconut-scheme based [Credential Library](https://coco-demo.nymtech.net/). This is a WASM implementation of our Coconut libraries which generate raw Coconut credentials. Test it to create and re-randomize your own credentials! +
Proxy traffic with the Nym Socks5 client: * set up a plug-and-play connection with the [NymConnect](./nymconnect-gui.md) GUI for proxying Telegram, Electrum, Keybase or Blockstream Green traffic through the mixnet (~2 minutes). * [Download and run](./socks-proxy.md) the Nym Socks5 client via the CLI, for other desktop applications with SOCKS5 connection options (~30 minutes). diff --git a/documentation/dev-portal/src/tutorials/simple-service-provider/sending-message.md b/documentation/dev-portal/src/tutorials/simple-service-provider/sending-message.md index a1a5f67ae9..d0083f0a01 100644 --- a/documentation/dev-portal/src/tutorials/simple-service-provider/sending-message.md +++ b/documentation/dev-portal/src/tutorials/simple-service-provider/sending-message.md @@ -12,7 +12,7 @@ Simply fill in the fields in your browser and click `Send`. In your browser you -This small project can be used as a template to start conceptualizing and developing more complex PEApps. Stay tuned for more soon, and if you're searching for inspiration check out the [community apps](../../community-resources/community-applications.md) list! +This small project can be used as a template to start conceptualizing and developing more complex PEApps. Stay tuned for more soon, and if you're searching for inspiration check out the [community apps](../../community-resources/community-applications-and-guides.md) list! diff --git a/documentation/dev-portal/theme/css/general.css b/documentation/dev-portal/theme/css/general.css index a06db43965..84dbfa3371 100644 --- a/documentation/dev-portal/theme/css/general.css +++ b/documentation/dev-portal/theme/css/general.css @@ -62,7 +62,8 @@ h3:target::before, h4:target::before, h5:target::before, h6:target::before { - display: inline-block; + /* display "none" in order to avoid default artifacts on the community-applications-and-guides page */ + display: none; content: "»"; margin-left: -30px; width: 30px;