Skip to content

Commit 7f7713d

Browse files
committed
add intro, getting started and few guides
1 parent ddceadf commit 7f7713d

File tree

8 files changed

+1976
-39
lines changed

8 files changed

+1976
-39
lines changed

.vitepress/sidebar.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -424,20 +424,20 @@ export function getSidebar() {
424424
text: '📖 Guides',
425425
items: [
426426
{
427-
text: 'Different ways to execute an iApp',
428-
link: '/use-iapp/guides/different-ways-to-execute',
427+
text: 'Find iApps to Use',
428+
link: '/use-iapp/guides/find-iapps',
429429
},
430430
{
431-
text: 'Add inputs to the execution',
432-
link: '/use-iapp/guides/add-inputs-to-execution',
431+
text: 'Different ways to execute an iApp',
432+
link: '/use-iapp/guides/different-ways-to-execute',
433433
},
434434
{
435435
text: 'Use iApp with Protected Data',
436436
link: '/use-iapp/guides/use-iapp-with-protected-data',
437437
},
438438
{
439-
text: 'Find iApps to Use',
440-
link: '/use-iapp/guides/find-iapps',
439+
text: 'Add inputs to the execution',
440+
link: '/use-iapp/guides/add-inputs-to-execution',
441441
},
442442
{
443443
text: 'How to pay the executions',
@@ -467,7 +467,7 @@ export function getSidebar() {
467467
],
468468
},
469469
{
470-
text: ' Web3Mail',
470+
text: '📨 Web3Mail',
471471
link: '/use-iapp/web3mail',
472472
collapsed: true,
473473
items: [

src/use-iapp/getting-started.md

Lines changed: 128 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,134 @@
11
---
22
title: Getting Started with iApps
3-
description: Getting started with iApps
3+
description: Learn the basics of finding and executing iApps on the iExec network
44
---
55

6-
# 🚀 Getting Started
6+
# 🚀 Getting Started with iApps
77

8-
This page is under development.
8+
Welcome to the world of secure, privacy-preserving computation! This guide will walk you through the essential steps to start using iApps on the iExec network.
99

10-
<!-- TODO: Add the iApps getting started guide -->
10+
## Prerequisites
11+
12+
Before you begin, make sure you have:
13+
14+
- A Web3 wallet (MetaMask, WalletConnect, etc.)
15+
- Some RLC tokens for paying computation fees (or access to free vouchers through learning programs)
16+
- Basic understanding of blockchain transactions
17+
18+
### 🆓 Use Our Stack for Free!
19+
20+
Good news! You can start using iApps **completely free** through our learning programs:
21+
22+
- **Learn Web3 Program**: Get free access to our entire stack, including vouchers for iApp executions
23+
- **Free Vouchers**: Pre-funded computation credits provided through learning initiatives
24+
- **No RLC Required**: Start experimenting and building without any upfront costs
25+
26+
### 💰 Getting Started Without RLC
27+
28+
Don't have RLC tokens yet? No problem! Our learning programs provide everything you need:
29+
30+
- **Free Vouchers**: Access to pre-funded computation credits
31+
- **Full Stack Access**: Use all iExec tools and infrastructure at no cost
32+
- **Educational Support**: Learn while you build with our community
33+
34+
Ready to dive in? Let's get started with finding and executing your first iApp!
35+
36+
## Step 1: Find Available iApps
37+
38+
The first step is discovering what iApps are available for your use case. You can find iApps through several methods:
39+
40+
1. Visit the [iExec Explorer](https://explorer.iex.ec)
41+
2. Navigate to the "Apps" section
42+
3. Browse available applications by category or search by name
43+
4. Check the app's description, requirements, and pricing
44+
45+
## Step 2: Understand App Requirements
46+
47+
Before executing an iApp, understand what it needs:
48+
49+
- **Protected Data**: Some apps require specific types of protected data
50+
- **Input Parameters**: Check if the app needs command-line arguments
51+
- **Input Files**: Some apps require additional files (URLs to public files)
52+
- **Secrets**: Certain apps need requester secrets for API keys, etc.
53+
54+
## Step 3: Prepare Your Data
55+
56+
If the iApp requires protected data:
57+
58+
1. **Protect Your Data**: Use the [Data Protector](/manage-data/dataProtector/dataProtectorCore/protectData) to encrypt your sensitive information
59+
2. **Grant Access**: Ensure the iApp has permission to access your protected data using [grantAccess](/manage-data/dataProtector/dataProtectorCore/grantAccess)
60+
61+
## Step 4: Execute the iApp
62+
63+
### Using the DataProtector SDK
64+
65+
```typescript
66+
import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector';
67+
68+
const web3Provider = getWeb3Provider(window.ethereum);
69+
const dataProtectorCore = new IExecDataProtectorCore(web3Provider);
70+
71+
// Execute the iApp with protected data
72+
const result = await dataProtectorCore.processProtectedData({
73+
protectedData: '0x123abc...', // Your protected data address
74+
app: '0x456def...', // The iApp address
75+
args: 'optional arguments',
76+
maxPrice: 10, // Maximum price in nRLC
77+
});
78+
```
79+
80+
### Using the CLI
81+
82+
```bash
83+
# Execute an iApp with protected data
84+
iexec app run 0x456def... --dataset 0x123abc... --args "your arguments"
85+
```
86+
87+
## Step 5: Monitor and Retrieve Results
88+
89+
After submitting your task:
90+
91+
1. **Monitor Progress**: Track your task on the [iExec Explorer](https://explorer.iex.ec)
92+
2. **Retrieve Results**: Get your results once the task completes
93+
94+
### Using the DataProtector SDK
95+
96+
```typescript
97+
// Retrieve results from a completed task
98+
const taskResult = await dataProtectorCore.getResultFromCompletedTask({
99+
taskId: '0x7ac398...', // Your task ID
100+
});
101+
```
102+
103+
### Using the CLI
104+
105+
```bash
106+
# Get task result
107+
iexec task show 0x7ac398...
108+
109+
# Download task result
110+
iexec task show 0x7ac398... --download
111+
```
112+
113+
## Step 6: Understand Costs
114+
115+
iApp execution costs include:
116+
117+
- **Application Fee**: Paid to the app developer
118+
- **Data Fee**: Paid to the data owner (if using protected data)
119+
- **Workerpool Fee**: Paid to the computation provider
120+
- **Gas Fees**: Blockchain transaction costs (free on Bellecour sidechain)
121+
122+
## Next Steps
123+
124+
Now that you understand the basics:
125+
126+
- Explore our [Guides](./guides/) for detailed tutorials
127+
- Learn about [Different Ways to Execute](./guides/different-ways-to-execute.md) iApps
128+
- Understand [How to Pay for Executions](./guides/how-to-pay-executions.md)
129+
- Discover how to [Use iApps with Protected Data](./guides/use-iapp-with-protected-data.md)
130+
131+
## Need Help?
132+
133+
- Check the [iExec Explorer](https://explorer.iex.ec) for app details
134+
- Visit our [Discord community](https://discord.gg/iexec) for support

0 commit comments

Comments
 (0)