|
1 | 1 | --- |
2 | | -title: Your Page Title |
3 | | -description: A brief description of what this page covers |
| 2 | +title: Build with iExec - Complete Workflow |
| 3 | +description: |
| 4 | + Step-by-step guide for developers to build and deploy applications with iExec |
| 5 | + technology |
4 | 6 | --- |
5 | 7 |
|
6 | | -# Your Page Heading |
| 8 | +# Build with iExec - Complete Workflow |
7 | 9 |
|
8 | | -Your content here... |
| 10 | +This guide walks you through building a complete application with iExec |
| 11 | +technology using DataProtector & IApp generator, from initial setup to live |
| 12 | +deployment. |
| 13 | + |
| 14 | +## Prerequisites |
| 15 | + |
| 16 | +- Node.js 20+ installed |
| 17 | +- Ethereum wallet |
| 18 | +- Docker installed & Docker Hub account |
| 19 | + |
| 20 | +## Step 1: Install iExec SDK and Tools |
| 21 | + |
| 22 | +```bash |
| 23 | +# Install iExec dependencies |
| 24 | +npm install @iexec/dataprotector @iexec/iapp |
| 25 | + |
| 26 | +``` |
| 27 | + |
| 28 | +## Step 2: Set a front end |
| 29 | + |
| 30 | +You will need a front-end application to allow users to interact with your |
| 31 | +platform and use DataProtector to protect their data. |
| 32 | + |
| 33 | +To quickly bootstrap a Next.js project with DataProtector installed, use our |
| 34 | +starter template: |
| 35 | +[iExec Next.js Starter](https://github.com/iExecBlockchainComputing/iexec-nextjs-starter) |
| 36 | + |
| 37 | +This template is composed with a simple Next.js project with a form enabling the |
| 38 | +data protection through Dataprotector. |
| 39 | + |
| 40 | +This starter is set up with iExec network by default, but you can change the |
| 41 | +deployment chain. |
| 42 | + |
| 43 | +## Step 3: Build Your iExec Application (iApp) |
| 44 | + |
| 45 | +### 3.1 Check iApp Generator installation. |
| 46 | + |
| 47 | +Open your terminal and check if the iApp generator package is well installed on |
| 48 | +your environment by running the following command: |
| 49 | + |
| 50 | +```bash |
| 51 | +iapp --version |
| 52 | +``` |
| 53 | + |
| 54 | +### 3.2 Init & Custom you iApp |
| 55 | + |
| 56 | +In order to compute protected data generated by DataProtector in a private and |
| 57 | +confidential TEE environment, you need to bootstrap and customize your |
| 58 | +application with iApp generator before deploying it on the selected chain. |
| 59 | +Please follow this guide: |
| 60 | +[iApp Generator](/references/iapp-generator/getting-started) |
| 61 | + |
| 62 | +### 3.3 Deploy your iApp |
| 63 | + |
| 64 | +Once your iApp is ready, you can deploy it on the selected chain by running the |
| 65 | +deploy command. Please follow this guide |
| 66 | +[Deploy an iApp](/guides/build-iapp/deploy-&-run) |
| 67 | + |
| 68 | +## Step 4: Manage access |
| 69 | + |
| 70 | +Once your DataProtector workflow is installed on your frontend and your iExec |
| 71 | +application is deployed, you can Manage Access. This means you need to authorize |
| 72 | +both a user and the iExec application to process the data using the Grant Access |
| 73 | +method. Please follow this guide |
| 74 | +[Manage Access](/guides/build-iapp/manage-access) |
| 75 | + |
| 76 | +## Next Steps |
| 77 | + |
| 78 | +- [Build an iApp](/guides/build-iapp/) |
| 79 | +- [Manage Data Products](/guides/manage-data/) |
| 80 | +- [Use iApps](/guides/use-iapp/) |
| 81 | +- [Advanced Features](/guides/build-iapp/advanced/) |
| 82 | + |
| 83 | +## Troubleshooting |
| 84 | + |
| 85 | +- **Connection Issues**: Ensure your wallet is connected to the correct network |
| 86 | + (iExec mainnet) |
| 87 | +- **Gas Fees**: Make sure you have sufficient RLC for transactions |
| 88 | +- **TEE Execution**: Verify your application is compatible with Trusted |
| 89 | + Execution Environments |
| 90 | +- **Data Access**: Check that your application has proper access to protected |
| 91 | + datasets |
| 92 | + |
| 93 | +## Support |
| 94 | + |
| 95 | +- [iExec Documentation](https://docs.iex.ec/) |
| 96 | +- [Community Discord](https://discord.gg/iexec) |
| 97 | +- [GitHub Issues](https://github.com/iExecBlockchainComputing/iexec-docs/issues) |
0 commit comments