You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This is the source repository of the [iExec documentation](https://docs.iex.ec)
3
+
## 📋 Prerequisites
4
4
5
-
## Prerequisites
5
+
-**Node.js**: Version 22 or higher
6
+
-**npm**: Comes bundled with Node.js
6
7
7
-
- Node 22
8
-
9
-
## Configuration
8
+
## ⚙️ Configuration
10
9
11
10
### Environment Variables (Optional)
12
11
13
-
Some features of the application require environment variables. This
14
-
configuration is optional and only needed if you plan to work with Hello World
15
-
pages. Create a `.env` file at the root of the project using the provided
16
-
`.env.example` as a template:
12
+
Some features of the application require environment variables. This configuration is optional and only needed if you plan to work with Hello World pages.
13
+
14
+
Create a `.env` file at the root of the project using the provided `.env.example` as a template:
17
15
18
16
```bash
19
17
cp .env.example .env
@@ -36,39 +34,103 @@ To obtain your `VITE_REOWN_PROJECT_ID`, follow these steps:
36
34
- Project name
37
35
- Description (optional)
38
36
- Website URL (optional)
39
-
5. Once the project is created, copy the "Project ID" displayed in the project
40
-
details
37
+
5. Once the project is created, copy the "Project ID" displayed in the project details
41
38
6. Paste this ID in your `.env` file as the value for `VITE_REOWN_PROJECT_ID`
42
39
43
-
## Run app
40
+
## 🚀 Getting Started
44
41
45
-
```
42
+
### Installation
43
+
44
+
Install the project dependencies:
45
+
46
+
```bash
46
47
npm install
48
+
```
49
+
50
+
### Development Server
51
+
52
+
Start the development server:
53
+
54
+
```bash
47
55
npm run dev
48
56
```
49
57
50
-
## Contributing
58
+
The documentation site will be available at `http://localhost:3000` (or the port shown in your terminal).
59
+
60
+
### Building for Production
61
+
62
+
To build the project for production:
63
+
64
+
```bash
65
+
npm run build
66
+
```
67
+
68
+
## 🤝 Contributing
69
+
70
+
We welcome contributions to improve the iExec documentation! Please follow these steps to contribute:
71
+
72
+
### 1. Fork the Repository
73
+
74
+
Fork this repository and ensure you're working on the `main` branch:
0 commit comments