Skip to content

Commit b9d6d41

Browse files
committed
docs: Update iApp guides to reflect new testing and deployment structure
- Renamed 'Build and Deploy' to 'Build and Test' in navigation and sidebar for consistency. - Added a new guide for 'Build and Test an iApp' detailing the creation and testing process. - Introduced a new guide for 'Deploy and Run an iApp' covering deployment methods and execution on the iExec network. - Updated links in existing documentation to align with the new guide structure.
1 parent 6387871 commit b9d6d41

File tree

6 files changed

+469
-171
lines changed

6 files changed

+469
-171
lines changed

.vitepress/config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ export default withMermaid(
101101
// https://vitepress.dev/reference/default-theme-config
102102
nav: [
103103
{ text: 'Get Started', link: '/get-started/welcome' },
104-
{ text: 'Guides', link: '/guides/build-iapp/build-&-deploy' },
104+
{ text: 'Guides', link: '/guides/build-iapp/build-&-test' },
105105
{ text: 'References', link: '/references/dataProtector' },
106106
{
107107
component: 'ChainSelector',

.vitepress/sidebar.ts

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -166,8 +166,12 @@ export function getSidebar() {
166166
text: 'BUILD YOUR iAPP',
167167
items: [
168168
{
169-
text: 'Build and Deploy',
170-
link: '/guides/build-iapp/build-&-deploy',
169+
text: 'Build and Test',
170+
link: '/guides/build-iapp/build-&-test',
171+
},
172+
{
173+
text: 'Deploy and Run',
174+
link: '/guides/build-iapp/deploy-&-run',
171175
},
172176
{
173177
text: 'Manage Access',

src/get-started/overview/what-is-iexec.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description:
1010
iExec is a **decentralized confidential computing toolkit** that helps
1111
developers build privacy-preserving applications.
1212

13-
## The Protocol (Simple Version)
13+
## SpeedRun The Protocol
1414

1515
### Step 1: Protect Data
1616

Lines changed: 6 additions & 166 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description:
44
How to create a confidential iExec application and deploy it on iExec protocol
55
---
66

7-
# Build and Deploy an iApp
7+
# Build and Test an iApp
88

99
iApp (iExec Applications) are decentralized applications that run on the iExec
1010
network. They use confidential computing to ensure data privacy and security
@@ -237,171 +237,11 @@ specify your app version, and push both standard and TEE-compatible images:
237237
/>
238238
</template>
239239

240-
<script setup>
241-
import CLIDemo from '@/components/CLIDemo.vue';
242-
import { computed } from 'vue';
243-
import useUserStore from '@/stores/useUser.store';
244-
245-
const userStore = useUserStore();
246-
const selectedChain = computed(() => userStore.getCurrentChainId());
247-
248-
const arbitrumSteps = [
249-
{
250-
showAt: 2,
251-
question: 'Using chain arbitrum-mainnet',
252-
answer: '',
253-
showTyping: false,
254-
isComplete: true
255-
},
256-
{
257-
showAt: 3,
258-
question: 'This method requires sending blockchain transactions, transaction fees will be applied. Would you like to continue?',
259-
answer: 'Yes',
260-
options: [
261-
{ label: 'Yes', selected: true },
262-
{ label: 'no', selected: false }
263-
],
264-
highlighted: false,
265-
showTyping: false,
266-
isComplete: false
267-
},
268-
{
269-
showAt: 4,
270-
question: 'Using saved walletPrivateKey (from iapp.config.json)',
271-
answer: '',
272-
showTyping: false,
273-
isComplete: true
274-
},
275-
{
276-
showAt: 5,
277-
completeAt: 7,
278-
question: 'What is your username on DockerHub? (It will be used to properly tag the Docker image)',
279-
answer: 'bob',
280-
showTyping: true,
281-
isComplete: false
282-
},
283-
{
284-
showAt: 7,
285-
completeAt: 9,
286-
question: 'What is your DockerHub access token?',
287-
answer: '**********************',
288-
showTyping: true,
289-
isComplete: false
290-
},
291-
{
292-
showAt: 9,
293-
completeAt: 11,
294-
question: 'What is the version of your iApp?',
295-
answer: '0.0.1',
296-
showTyping: true,
297-
isComplete: false
298-
},
299-
{
300-
showAt: 11,
301-
question: 'Docker image built (sha256:a53fc4c480f482c384a13266ea2cb6cc5572733c866c44a5f604f4bfab3a744a) and tagged bob/hello-world:0.0.1',
302-
answer: '',
303-
showTyping: false,
304-
isComplete: true
305-
},
306-
{
307-
showAt: 12,
308-
question: 'Pushed image bob/hello-world:0.0.1 on dockerhub',
309-
answer: '',
310-
showTyping: false,
311-
isComplete: true
312-
},
313-
{
314-
showAt: 13,
315-
question: 'Pushed TEE image bob/hello-world:0.0.1-tee-scone-5.9.1-v16-ce3a01d9c5d7 on dockerhub',
316-
answer: '',
317-
showTyping: false,
318-
isComplete: true
319-
},
320-
{
321-
showAt: 14,
322-
question: 'TEE app deployed',
323-
answer: '',
324-
showTyping: false,
325-
isComplete: true
326-
}
327-
];
240+
## Next Steps
328241

329-
const bellecourSteps = [
330-
{
331-
showAt: 2,
332-
question: 'Using chain bellecour',
333-
answer: '',
334-
showTyping: false,
335-
isComplete: true
336-
},
337-
{
338-
showAt: 3,
339-
question: 'Using saved walletPrivateKey (from iapp.config.json)',
340-
answer: '',
341-
showTyping: false,
342-
isComplete: true
343-
},
344-
{
345-
showAt: 4,
346-
completeAt: 6,
347-
question: 'What is your username on DockerHub? (It will be used to properly tag the Docker image)',
348-
answer: 'bob',
349-
showTyping: true,
350-
isComplete: false
351-
},
352-
{
353-
showAt: 6,
354-
completeAt: 8,
355-
question: 'What is your DockerHub access token?',
356-
answer: '**********************',
357-
showTyping: true,
358-
isComplete: false
359-
},
360-
{
361-
showAt: 8,
362-
completeAt: 10,
363-
question: 'What is the version of your iApp?',
364-
answer: '0.0.1',
365-
showTyping: true,
366-
isComplete: false
367-
},
368-
{
369-
showAt: 10,
370-
question: 'Docker image built (sha256:a53fc4c480f482c384a13266ea2cb6cc5572733c866c44a5f604f4bfab3a744a) and tagged bob/hello-world:0.0.1',
371-
answer: '',
372-
showTyping: false,
373-
isComplete: true
374-
},
375-
{
376-
showAt: 11,
377-
question: 'Pushed image bob/hello-world:0.0.1 on dockerhub',
378-
answer: '',
379-
showTyping: false,
380-
isComplete: true
381-
},
382-
{
383-
showAt: 12,
384-
question: 'Pushed TEE image bob/hello-world:0.0.1-tee-scone-5.9.1-v16-ce3a01d9c5d7 on dockerhub',
385-
answer: '',
386-
showTyping: false,
387-
isComplete: true
388-
},
389-
{
390-
showAt: 13,
391-
question: 'TEE app deployed',
392-
answer: '',
393-
showTyping: false,
394-
isComplete: true
395-
}
396-
];
242+
- When everything is ready
243+
[deploy and run your iApp](../use-iapp/run-iapp-with-inputs)
397244

398-
const arbitrumCompletionItems = [
399-
'└ Docker image: bob/hello-world:0.0.1-tee-scone-5.9.1-v16-ce3a01d9c5d7',
400-
'└ iApp address: 0x1f80DCebc2EAAff0Db7156413C43B7e88D189923'
401-
];
402-
403-
const bellecourCompletionItems = [
404-
'└ Docker image: bob/hello-world:0.0.1-tee-scone-5.9.1-v16-ce3a01d9c5d7',
405-
'└ iApp address: 0x1f80DCebc2EAAff0Db7156413C43B7e88D189923'
406-
];
245+
<script setup>
246+
import CLIDemo from '@/components/CLIDemo.vue';
407247
</script>

0 commit comments

Comments
 (0)