From 0028fb5d57711e4ab7547dc547f6120cf2a1f6bf Mon Sep 17 00:00:00 2001 From: akugone Date: Mon, 26 May 2025 11:53:28 +0200 Subject: [PATCH 1/8] feat: Enhance iApp documentation with detailed use cases and improved introduction of iApp generator --- overview/helloWorld/3-buildIApp.md | 46 ++++++++++++++++++++++++------ 1 file changed, 37 insertions(+), 9 deletions(-) diff --git a/overview/helloWorld/3-buildIApp.md b/overview/helloWorld/3-buildIApp.md index 1a368e75..d6ec4cd0 100644 --- a/overview/helloWorld/3-buildIApp.md +++ b/overview/helloWorld/3-buildIApp.md @@ -5,17 +5,15 @@

Time to build!

-

Let's build an iApp that can process protected data in a secure environment.

-
-
+

Let's build an iApp that can process protected data in a secure environment using the iExec iApp generator tool. This tool helps you create, test and deploy iApps with just a few commands.

-
-

An iApp runs in a Trusted Execution Environment (TEE), it can process data in a secure environment.

+
-This guide will help you set up, test, deploy and run your iApp using the -[`iapp-cli`](https://github.com/iExecBlockchainComputing/iapp/tree/main/cli) -tool. Follow the instructions carefully for a smooth development experience. +If you wanna explore and deep dive in the CLI. You can check the +[iapp-cli](https://github.com/iExecBlockchainComputing/iapp/tree/main/cli) +github repository. Follow the instructions carefully for a smooth development +experience. ## πŸ“‹ Prerequisites @@ -42,6 +40,36 @@ Before getting started, ensure you have the following:

Don't worry! All secrets used in this tutorial stay on your machine and aren’t shared with anyone. You’ll only need them to run the iApp run command.

+## πŸš€ Types of iApps You Can Build + +iExec enables you to build various types of confidential applications. Here are +some popular use cases: + +### πŸ“§ Web3 Mail + +Send privacy-preserving emails to registered Ethereum account holders without +knowing or storing their email addresses. +[Github](https://github.com/iExecBlockchainComputing/web3mail-sdk/tree/main/dapp) +| [Documentation](https://tools.docs.iex.ec/tools/web3mail) + +### πŸ’¬ Web3 Telegram + +Send privacy-preserving Telegram messages without knowing or storing their +Telegram addresses. +[Github](https://github.com/iExecBlockchainComputing/web3telegram-sdk/tree/main/dapp) +| [Documentation](https://tools.docs.iex.ec/tools/web3telegram) + +### 🌐 Content Delivery + +Transfer, sell or rent protected content to authorized users. +[Github](https://github.com/iExecBlockchainComputing/dataprotector-sdk/tree/main/packages/protected-data-delivery-dapp) +| +[Documentation](https://tools.docs.iex.ec/tools/dataProtector/dataProtectorSharing) + +
+

These are just a few examples, the possibilities are endless. Want to explore iApp Generator? Check out our documentation and see what you can build!

+
+ ## πŸ’Ύ Installation (win / mac / linux) First, you need to install the `iapp` package. Open your terminal and run: @@ -60,7 +88,7 @@ iapp --version iapp --help ``` -## πŸ› οΈ Initialize Framework +## πŸ› οΈ Bootstrap your iApp To initialize the working directory for developing your iApp, use the `iapp init` command. This command sets up the necessary project structure and From f04330b670cd948270636cab46d2e5bef80a974f Mon Sep 17 00:00:00 2001 From: akugone Date: Mon, 26 May 2025 11:57:16 +0200 Subject: [PATCH 2/8] fix: Update terminology in iApp documentation to reflect Privacy-preserving applications --- overview/helloWorld/3-buildIApp.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/overview/helloWorld/3-buildIApp.md b/overview/helloWorld/3-buildIApp.md index d6ec4cd0..a69bf1bf 100644 --- a/overview/helloWorld/3-buildIApp.md +++ b/overview/helloWorld/3-buildIApp.md @@ -42,8 +42,8 @@ Before getting started, ensure you have the following: ## πŸš€ Types of iApps You Can Build -iExec enables you to build various types of confidential applications. Here are -some popular use cases: +iExec enables you to build various types of Privacy-preserving applications. +Here are some popular use cases: ### πŸ“§ Web3 Mail From d19f35bda4493b297fe11a9c5237c8f71499256d Mon Sep 17 00:00:00 2001 From: akugone Date: Mon, 26 May 2025 11:57:42 +0200 Subject: [PATCH 3/8] fix: Update terminology in iApp documentation to use 'Telegram handles' instead of 'Telegram addresses' --- overview/helloWorld/3-buildIApp.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/overview/helloWorld/3-buildIApp.md b/overview/helloWorld/3-buildIApp.md index a69bf1bf..80f6a989 100644 --- a/overview/helloWorld/3-buildIApp.md +++ b/overview/helloWorld/3-buildIApp.md @@ -55,7 +55,7 @@ knowing or storing their email addresses. ### πŸ’¬ Web3 Telegram Send privacy-preserving Telegram messages without knowing or storing their -Telegram addresses. +Telegram handles. [Github](https://github.com/iExecBlockchainComputing/web3telegram-sdk/tree/main/dapp) | [Documentation](https://tools.docs.iex.ec/tools/web3telegram) From 34bf4a8f0380b575aaa71195334e86c521ab6ab0 Mon Sep 17 00:00:00 2001 From: MartinLeclercq Date: Wed, 18 Jun 2025 10:47:32 +0200 Subject: [PATCH 4/8] Update overview/helloWorld/3-buildIApp.md Co-authored-by: Erwan Decoster <36567542+ErwanDecoster@users.noreply.github.com> --- overview/helloWorld/3-buildIApp.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/overview/helloWorld/3-buildIApp.md b/overview/helloWorld/3-buildIApp.md index 80f6a989..28ef57c8 100644 --- a/overview/helloWorld/3-buildIApp.md +++ b/overview/helloWorld/3-buildIApp.md @@ -57,7 +57,7 @@ knowing or storing their email addresses. Send privacy-preserving Telegram messages without knowing or storing their Telegram handles. [Github](https://github.com/iExecBlockchainComputing/web3telegram-sdk/tree/main/dapp) -| [Documentation](https://tools.docs.iex.ec/tools/web3telegram) +| [Documentation](../../tools/web3telegram.md) ### 🌐 Content Delivery From e7512093a284d324a140c877dbd3ece63e7684ee Mon Sep 17 00:00:00 2001 From: MartinLeclercq Date: Wed, 18 Jun 2025 10:47:52 +0200 Subject: [PATCH 5/8] Update overview/helloWorld/3-buildIApp.md Co-authored-by: Erwan Decoster <36567542+ErwanDecoster@users.noreply.github.com> --- overview/helloWorld/3-buildIApp.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/overview/helloWorld/3-buildIApp.md b/overview/helloWorld/3-buildIApp.md index 28ef57c8..703c7444 100644 --- a/overview/helloWorld/3-buildIApp.md +++ b/overview/helloWorld/3-buildIApp.md @@ -50,7 +50,7 @@ Here are some popular use cases: Send privacy-preserving emails to registered Ethereum account holders without knowing or storing their email addresses. [Github](https://github.com/iExecBlockchainComputing/web3mail-sdk/tree/main/dapp) -| [Documentation](https://tools.docs.iex.ec/tools/web3mail) +| [Documentation](../../tools/web3mail.md) ### πŸ’¬ Web3 Telegram From 562d73b1ca6e63055a05aba038c4f9edd20fa3ca Mon Sep 17 00:00:00 2001 From: MartinLeclercq Date: Wed, 18 Jun 2025 10:48:02 +0200 Subject: [PATCH 6/8] Update overview/helloWorld/3-buildIApp.md Co-authored-by: Erwan Decoster <36567542+ErwanDecoster@users.noreply.github.com> --- overview/helloWorld/3-buildIApp.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/overview/helloWorld/3-buildIApp.md b/overview/helloWorld/3-buildIApp.md index 703c7444..0df4ef72 100644 --- a/overview/helloWorld/3-buildIApp.md +++ b/overview/helloWorld/3-buildIApp.md @@ -64,7 +64,7 @@ Telegram handles. Transfer, sell or rent protected content to authorized users. [Github](https://github.com/iExecBlockchainComputing/dataprotector-sdk/tree/main/packages/protected-data-delivery-dapp) | -[Documentation](https://tools.docs.iex.ec/tools/dataProtector/dataProtectorSharing) +[Documentation](../../tools/dataProtector/dataProtectorSharing.md)

These are just a few examples, the possibilities are endless. Want to explore iApp Generator? Check out our documentation and see what you can build!

From 637da9424ac7ae764c94f7b09b39e43621dcf6f5 Mon Sep 17 00:00:00 2001 From: MartinLeclercq Date: Wed, 18 Jun 2025 10:48:18 +0200 Subject: [PATCH 7/8] Update overview/helloWorld/3-buildIApp.md Co-authored-by: Erwan Decoster <36567542+ErwanDecoster@users.noreply.github.com> --- overview/helloWorld/3-buildIApp.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/overview/helloWorld/3-buildIApp.md b/overview/helloWorld/3-buildIApp.md index 0df4ef72..f23ee209 100644 --- a/overview/helloWorld/3-buildIApp.md +++ b/overview/helloWorld/3-buildIApp.md @@ -67,7 +67,7 @@ Transfer, sell or rent protected content to authorized users. [Documentation](../../tools/dataProtector/dataProtectorSharing.md)
-

These are just a few examples, the possibilities are endless. Want to explore iApp Generator? Check out our documentation and see what you can build!

+

These are just a few examples, the possibilities are endless. Want to explore iApp Generator? Check out our documentation and see what you can build!

## πŸ’Ύ Installation (win / mac / linux) From ea64a0a192d5d523f8ed65f866186e8d70997c0a Mon Sep 17 00:00:00 2001 From: ErwanDecoster Date: Wed, 18 Jun 2025 17:33:41 +0200 Subject: [PATCH 8/8] fix: Update relative links in documentation for consistency and accuracy --- overview/helloWorld/1-overview.md | 2 +- overview/helloWorld/3-buildIApp.md | 7 +++---- overview/helloWorld/4-manageDataAccess.md | 2 +- 3 files changed, 5 insertions(+), 6 deletions(-) diff --git a/overview/helloWorld/1-overview.md b/overview/helloWorld/1-overview.md index fa458850..19ce800b 100644 --- a/overview/helloWorld/1-overview.md +++ b/overview/helloWorld/1-overview.md @@ -87,7 +87,7 @@ Computing technologies. iExec combines three fundamental elements that work together seamlessly: -#### 1. Protect data with our devtool [DataProtector](https://tools.docs.iex.ec/tools/dataProtector/getting-started) +#### 1. Protect data with our devtool [DataProtector](../../tools/dataProtector/getting-started) - Encrypt your sensitive data and store it securely on IPFS - Only you control who can access it and when diff --git a/overview/helloWorld/3-buildIApp.md b/overview/helloWorld/3-buildIApp.md index f23ee209..2b15213b 100644 --- a/overview/helloWorld/3-buildIApp.md +++ b/overview/helloWorld/3-buildIApp.md @@ -5,7 +5,7 @@

Time to build!

-

Let's build an iApp that can process protected data in a secure environment using the iExec iApp generator tool. This tool helps you create, test and deploy iApps with just a few commands.

+

Let's build an iApp that can process protected data in a secure environment using the iExec iApp generator tool. This tool helps you create, test and deploy iApps with just a few commands.

@@ -63,11 +63,10 @@ Telegram handles. Transfer, sell or rent protected content to authorized users. [Github](https://github.com/iExecBlockchainComputing/dataprotector-sdk/tree/main/packages/protected-data-delivery-dapp) -| -[Documentation](../../tools/dataProtector/dataProtectorSharing.md) +| [Documentation](../../tools/dataProtector/dataProtectorSharing)
-

These are just a few examples, the possibilities are endless. Want to explore iApp Generator? Check out our documentation and see what you can build!

+

These are just a few examples, the possibilities are endless. Want to explore iApp Generator? Check out our documentation and see what you can build!

## πŸ’Ύ Installation (win / mac / linux) diff --git a/overview/helloWorld/4-manageDataAccess.md b/overview/helloWorld/4-manageDataAccess.md index 4c66ac73..f4847ecf 100644 --- a/overview/helloWorld/4-manageDataAccess.md +++ b/overview/helloWorld/4-manageDataAccess.md @@ -123,7 +123,7 @@ Want to see it in action? Check out our - Track your earnings For more technical details, see the -[DataProtector Sharing](https://beta.tools.docs.iex.ec/tools/dataProtector/dataProtectorSharing.html) +[DataProtector Sharing](../../tools/dataProtector/dataProtectorSharing.html) documentation.