Skip to content

Commit 8b8ce39

Browse files
docs: update readme
1 parent ab71d53 commit 8b8ce39

File tree

1 file changed

+35
-6
lines changed

1 file changed

+35
-6
lines changed

README.md

Lines changed: 35 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,33 @@
1-
# React + TypeScript + Vite
1+
# iExec explorer
2+
3+
## Install
4+
5+
```sh
6+
npm ci
7+
npm run codegen
8+
```
9+
10+
## Develop
11+
12+
```sh
13+
# npm ci
14+
# npm run codegen
15+
npm run dev
16+
```
17+
18+
browse <http://localhost:5173>
19+
20+
## Build
21+
22+
```sh
23+
# npm ci
24+
# npm run codegen
25+
npm run build
26+
```
27+
28+
You can serve the build with `npx serve -p 3000 ./dist` and browse <http://localhost:3000>
29+
30+
## Template: React + TypeScript + Vite
231

332
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
433

@@ -7,7 +36,7 @@ Currently, two official plugins are available:
736
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
837
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
938

10-
## Expanding the ESLint configuration
39+
### Expanding the ESLint configuration
1140

1241
If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
1342

@@ -28,15 +57,15 @@ export default tseslint.config({
2857
tsconfigRootDir: import.meta.dirname,
2958
},
3059
},
31-
})
60+
});
3261
```
3362

3463
You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
3564

3665
```js
3766
// eslint.config.js
38-
import reactX from 'eslint-plugin-react-x'
39-
import reactDom from 'eslint-plugin-react-dom'
67+
import reactDom from 'eslint-plugin-react-dom';
68+
import reactX from 'eslint-plugin-react-x';
4069

4170
export default tseslint.config({
4271
plugins: {
@@ -50,5 +79,5 @@ export default tseslint.config({
5079
...reactX.configs['recommended-typescript'].rules,
5180
...reactDom.configs.recommended.rules,
5281
},
53-
})
82+
});
5483
```

0 commit comments

Comments
 (0)