Skip to content

feat(docs): add compatible Node.js and Python versions to Build Your … #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Le-Caignec merged 6 commits into from
Sep 24, 2025
Merged

feat(docs): add compatible Node.js and Python versions to Build Your … #71

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7f8e163
feat(docs): add compatible Node.js and Python versions to Build Your …
abbesBenayache Sep 23, 2025
6b26e46
refactor(docs): eliminate duplication by centralizing prerequisites i…
abbesBenayache Sep 23, 2025
d32c55a
Merge remote-tracking branch 'origin/main' into feat/add-compatible-n…
abbesBenayache Sep 23, 2025
b7b3c2d
style: fix prettier formatting issues
abbesBenayache Sep 23, 2025
4a37224
fix(docs): clarify Node.js version requirement for JavaScript iApps
Le-Caignec Sep 24, 2025
a34e1f2
Merge branch 'main' into feat/add-compatible-node-python-versions
Le-Caignec Sep 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 66 additions & 0 deletions src/references/iapp-generator/building-your-iexec-app.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,72 @@

# 🧑‍🏭 Build your iApp

## 📋 Prerequisites

Before building your iApp, ensure you have the following installed:

<div class="flex flex-col gap-2 my-4 pl-0">
<div class="flex items-center gap-4 text-left">
<div class="flex items-center gap-1 flex-1 text-sm font-medium">
📦 Node.js v20+
</div>
<a target="_blank" href="https://nodejs.org/en/" class="no-underline! text-sm ml-auto hover:underline!">Download →</a>
</div>
<div class="flex items-center gap-4 text-left">
<div class="flex items-center gap-1 flex-1 text-sm font-medium">
🐍 Python 3.8+ (for Python iApps)

Check notice on line 23 in src/references/iapp-generator/building-your-iexec-app.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/references/iapp-generator/building-your-iexec-app.md#L23 

[Google.Parens] Use parentheses judiciously.
Raw output 
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "src/references/iapp-generator/building-your-iexec-app.md", "range": {"start": {"line": 23, "column": 21}}}, "severity": "INFO"}

Check failure on line 23 in src/references/iapp-generator/building-your-iexec-app.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/references/iapp-generator/building-your-iexec-app.md#L23 

[Vale.Spelling] Did you really mean 'iApps'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'iApps'?", "location": {"path": "src/references/iapp-generator/building-your-iexec-app.md", "range": {"start": {"line": 23, "column": 33}}}, "severity": "ERROR"}
</div>
<a target="_blank" href="https://www.python.org/downloads/" class="no-underline! text-sm ml-auto hover:underline!">Download →</a>
</div>
<div class="flex items-center gap-4 text-left">
<div class="flex items-center gap-1 flex-1 text-sm font-medium">
🐳 Docker installed
</div>
<a target="_blank" href="https://docker.com/" class="no-underline! text-sm ml-auto hover:underline!">Download →</a>
</div>

<div class="flex items-center gap-4 text-left">
<div class="flex items-center gap-1 flex-1 text-sm font-medium">
🐳 DockerHub Account

Check failure on line 36 in src/references/iapp-generator/building-your-iexec-app.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/references/iapp-generator/building-your-iexec-app.md#L36 

[Vale.Terms] Use 'Dockerhub' instead of 'DockerHub'.
Raw output 
{"message": "[Vale.Terms] Use 'Dockerhub' instead of 'DockerHub'.", "location": {"path": "src/references/iapp-generator/building-your-iexec-app.md", "range": {"start": {"line": 36, "column": 9}}}, "severity": "ERROR"}
</div>
<a target="_blank" href="https://hub.docker.com/" class="no-underline! text-sm ml-auto hover:underline!">Sign Up →</a>
</div>
</div>

::: tip 🔍 Verify Docker Compatibility

```bash
docker buildx inspect --bootstrap | grep -i platforms
```

If `linux/amd64` is not listed, **update your Docker installation.**

Check notice on line 48 in src/references/iapp-generator/building-your-iexec-app.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/references/iapp-generator/building-your-iexec-app.md#L48 

[Google.Contractions] Use 'isn't' instead of 'is not'.
Raw output 
{"message": "[Google.Contractions] Use 'isn't' instead of 'is not'.", "location": {"path": "src/references/iapp-generator/building-your-iexec-app.md", "range": {"start": {"line": 48, "column": 18}}}, "severity": "INFO"}

:::

### 📦 Install iApp Generator

Install the iApp Generator CLI tool using your preferred package manager:

Check warning on line 54 in src/references/iapp-generator/building-your-iexec-app.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/references/iapp-generator/building-your-iexec-app.md#L54 

[Google.WordList] Use 'command-line tool' instead of 'CLI'.
Raw output 
{"message": "[Google.WordList] Use 'command-line tool' instead of 'CLI'.", "location": {"path": "src/references/iapp-generator/building-your-iexec-app.md", "range": {"start": {"line": 54, "column": 28}}}, "severity": "WARNING"}

::: code-group

```sh [npm]
npm install -g @iexec/iapp
```

```sh [yarn]
yarn global add @iexec/iapp
```

```sh [pnpm]
pnpm add -g @iexec/iapp
```

```sh [bun]
bun add -g @iexec/iapp
```

:::

## 🧰 Initialize your iApp

The iApp (iExec App) Generator command-line tool simplifies the setup of your
Expand Down