Skip to content

Commit 0a293ec

Browse files
authored
Merge pull request #108 from FlowTestAI/readme-update-nodejs
Updating the README.md file with Node.js installation steps
2 parents 0735716 + b8b8923 commit 0a293ec

1 file changed

Lines changed: 36 additions & 1 deletion

File tree

README.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,42 @@ FlowTestAI is an electron app that runs entirely in your local environment inter
2828

2929
## Development 🔧
3030

31+
### Prerequisite
32+
33+
This package uses version 18 of Node.js. There are different ways that you can install Node.js, following are steps for [Node Verson Manager or NVM](https://github.com/nvm-sh/nvm). If you need steps for other methods than NVM then please check [Official Node.js documentation](https://nodejs.org/en/download/package-manager).
34+
35+
1. Installs nvm (Node Version Manager)
36+
37+
```bash
38+
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
39+
```
40+
41+
2. Download and install Node.js
42+
43+
```bash
44+
nvm install 18
45+
```
46+
47+
3. Verifies the right Node.js version is in the environment
48+
49+
```bash
50+
node -v # should print `v18.20.2`
51+
```
52+
53+
4. Verifies the right NPM version is in the environment
54+
55+
```bash
56+
npm -v # should print `10.5.0`
57+
```
58+
59+
### Main setup
60+
3161
1. Clone the repository
62+
3263
```bash
3364
git clone https://github.com/FlowTestAI/FlowTest.git
3465
```
66+
3567
2. Go into repository folder
3668

3769
```bash
@@ -51,9 +83,11 @@ FlowTestAI is an electron app that runs entirely in your local environment inter
5183
```
5284

5385
4. Install all project dependencies:
86+
5487
```bash
5588
pnpm install
5689
```
90+
5791
5. Build and start the app:
5892

5993
```bash
@@ -65,7 +99,8 @@ FlowTestAI is an electron app that runs entirely in your local environment inter
6599
NOTE: if you use npm and corepack to install pnpm you will have two instances of pnpm. Make sure the version you're using is the correct version for the repo. Check the [pnpm docs](https://pnpm.io/installation) and [corepack](https://github.com/nodejs/corepack) for troubleshooting. Pnpm installed with npm will overrun corepacks pnpm instance.
66100

67101
## Contribution 🤝
68-
*"Little drops of water make a mighty ocean"*
102+
103+
_"Little drops of water make a mighty ocean"_
69104

70105
No contribution is small even if it means fixing a spelling mistake. Follow our contributing guide below.
71106
https://github.com/FlowTestAI/FlowTest/blob/main/CONTRIBUTING.md

0 commit comments

Comments
 (0)