Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
fe248ea
fix: HelloWorld and add required package
ErwanDecoster Jul 30, 2025
291ab9d
refactor: update gradient direction in styles for consistency across …
ErwanDecoster Jul 30, 2025
ca2613d
refactor: improve formatting and consistency in InfoIcon component an…
ErwanDecoster Jul 30, 2025
5bd4fd1
Merge remote-tracking branch 'origin/migration' into feature/add-hell…
ErwanDecoster Jul 30, 2025
ec67bf2
fix: move AskIaButton component to work with tailwind
ErwanDecoster Jul 31, 2025
2b8d07c
refactor: update Button component usage in bonus chapter for improved…
ErwanDecoster Jul 31, 2025
d048949
Merge branch 'main' into feature/add-hello-world
ErwanDecoster Jul 31, 2025
f018846
refactor: replace button element with dynamic component for flexible …
ErwanDecoster Jul 31, 2025
d9f19e1
fix: update heading styles for consistency across documentation
ErwanDecoster Jul 31, 2025
45f3eb1
fix: adjust class order and formatting in Button component for improv…
ErwanDecoster Jul 31, 2025
c4e50cb
fix: adjust class order in AddressChip component for improved styling…
ErwanDecoster Aug 1, 2025
13531e5
fix: remove unnecessary class from Button component in GrantAccess an…
ErwanDecoster Aug 1, 2025
01ac853
fix: uncomment and import components in protectData and manageDataAcc…
ErwanDecoster Aug 1, 2025
4f426a0
docs: add configuration section for environment variables in README
ErwanDecoster Aug 1, 2025
57b517e
fix: update README for clarity and organization, including prerequisi…
ErwanDecoster Aug 1, 2025
3e367a9
fix: update link styles in helloWorld and 3-buildIApp for consistency
ErwanDecoster Aug 1, 2025
248071b
fix: improve formatting and clarity in README for better readability
ErwanDecoster Aug 1, 2025
9fefed0
fix: typo
Le-Caignec Aug 1, 2025
9e35774
Merge branch 'feature/add-hello-world' of https://github.com/iExecBlo…
Le-Caignec Aug 1, 2025
95d7225
fix: improve error message
Le-Caignec Aug 1, 2025
cb92d4b
Merge branch 'main' into feature/add-hello-world
Le-Caignec Aug 1, 2025
e68df53
fix: format
Le-Caignec Aug 1, 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
1 change: 1 addition & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
VITE_REOWN_PROJECT_ID=
2 changes: 1 addition & 1 deletion .vitepress/theme/Layout.vue
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<script setup>
import DefaultTheme from 'vitepress/theme';
import AskIaButton from './AskIaButton.vue';
import AskIaButton from '../../src/components/AskIaButton.vue';

const { Layout } = DefaultTheme;
</script>
Expand Down
11 changes: 10 additions & 1 deletion .vitepress/theme/index.ts
Original file line number Diff line number Diff line change
@@ -1,20 +1,29 @@
// https://vitepress.dev/guide/custom-theme
import type { Theme } from 'vitepress';
import DefaultTheme from 'vitepress/theme';
import './style.css';
import TwoslashFloatingVue from '@shikijs/vitepress-twoslash/client';
import Layout from './Layout.vue';
import type { EnhanceAppContext } from 'vitepress';
import googleAnalytics from 'vitepress-plugin-google-analytics';
import 'virtual:group-icons.css';
import '@shikijs/vitepress-twoslash/style.css';
import { QueryClient, VueQueryPlugin } from '@tanstack/vue-query';
import { WagmiPlugin } from '@wagmi/vue';
import { wagmiAdapter } from '../../src/utils/wagmiConfig';
import './style.css';

export default {
extends: DefaultTheme,
Layout,
enhanceApp({ app }: EnhanceAppContext) {
app.use(TwoslashFloatingVue as any);

const queryClient = new QueryClient();

app.use(VueQueryPlugin, { queryClient });

app.use(WagmiPlugin, { config: wagmiAdapter.wagmiConfig });

googleAnalytics({
id: 'GTM-P7KSD4T',
});
Expand Down
12 changes: 12 additions & 0 deletions .vitepress/theme/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -136,3 +136,15 @@ html {
.aside .aside-container {
@apply overflow-visible;
}

html.dark .light-only {
display: none !important;
}

html:not(.dark) .dark-only {
display: none !important;
}

input {
@apply w-full rounded-md border border-[var(--vp-c-divider)] bg-[var(--vp-c-bg-soft)] px-4 py-3 text-base text-[var(--vp-c-text-1)] transition focus:border-[var(--vp-c-brand-2)] focus:outline-none disabled:cursor-not-allowed disabled:opacity-70;
}
151 changes: 131 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,151 @@
# iExec Tools documentation
# iExec Documentation

This is the source repository of the [iExec documentation](https://docs.iex.ec)
## 📋 Prerequisites

## Prerequisites
- **Node.js**: Version 22 or higher
- **npm**: Comes bundled with Node.js

- Node 22
## ⚙️ Configuration

## Run app
### Environment Variables (Optional)

Some features of the application require environment variables. This
configuration is optional and only needed if you plan to work with Hello World
pages.

Create a `.env` file at the root of the project using the provided
`.env.example` as a template:

```bash
cp .env.example .env
```

Then fill in the required values:

```env
VITE_REOWN_PROJECT_ID=your_project_id_here
```

#### Getting your VITE_REOWN_PROJECT_ID

To obtain your `VITE_REOWN_PROJECT_ID`, follow these steps:

1. Go to [https://dashboard.reown.com/](https://dashboard.reown.com/)
2. Create an account if you don't have one already
3. Once logged in, click on "Create Project" or "New Project"
4. Fill in your project information:
- Project name
- Description (optional)
- Website URL (optional)
5. Once the project is created, copy the "Project ID" displayed in the project
details
6. Paste this ID in your `.env` file as the value for `VITE_REOWN_PROJECT_ID`

## 🚀 Getting Started

### Installation

Install the project dependencies:

```bash
npm install
```

### Development Server

Start the development server:

```bash
npm run dev
```

## Contributing
The documentation site will be available at `http://localhost:3000` (or the port
shown in your terminal).

### Building for Production

To build the project for production:

```bash
npm run build
```

## 🤝 Contributing

We welcome contributions to improve the iExec documentation! Please follow these
steps to contribute:

### 1. Fork the Repository

Fork this repository and ensure you're working on the `main` branch:

[![fork-button](./src/public/fork-button.png)](https://github.com/iExecBlockchainComputing/documentation/fork)

### 2. Set Up Your Development Environment

1. Clone your forked repository:

```bash
git clone https://github.com/YOUR_USERNAME/documentation.git
cd documentation
```

2. Install dependencies:

```bash
npm install
```

3. Start the development server:
```bash
npm run dev
```

### 3. Make Your Changes

1. Create a new branch for your feature/fix:

```bash
git checkout -b feature/your-feature-name
```

2. Make your changes to the documentation
3. Test your changes locally to ensure they work as expected

### 4. Submit Your Changes

1. Stage and commit your changes with a descriptive message:

To keep the contribution process smooth, please read this small guide.
```bash
git add .
git commit -m "Add: descriptive commit message"
```

### Fork
2. Push your changes to your forked repository:

Fork the repo and be sure to be on `main` branch
```bash
git push origin feature/your-feature-name
```

[![fork-button](./public/fork-button.png)](https://github.com/iExecBlockchainComputing/documentation/fork)
3. Open a pull request from your feature branch to our `main` branch

### Contribute
### 5. Review Process

Apply your changes on your forked branch, stage them and commit them with a
descriptive commit message.
> **💡 Tips:**
>
> - You can open a draft pull request and mark it as "Ready for review" once
> you're satisfied with the preview
> - All pull requests are reviewed by our team before being merged
> - Feel free to ask questions in the pull request if you need clarification

Push your changes to your forked branch.
## 📄 License

### PR time
This project is part of the iExec ecosystem. Please refer to the main iExec
repositories for licensing information.

Open a pull request from your forked branch to our `main` branch.
## 🆘 Support

> _**Tips:**_
> You can open a draft pull request and set it to "Ready for review" once you
> are happy with the preview. Opened pull requests will be reviewed by the team
> and merged once approved.
- 📖 [Documentation](https://docs.iex.ec)
- 💬 [Discord Community](https://discord.com/invite/pbt9m98wnU)
- 🐛
[Issue Tracker](https://github.com/iExecBlockchainComputing/documentation/issues)
Loading