Skip to content

Commit 010e0a4

Browse files
authored
Merge pull request #96 from joaomlneto/windows-setup
Windows setup
2 parents 4cc6da4 + d7ce326 commit 010e0a4

File tree

1 file changed

+63
-0
lines changed

1 file changed

+63
-0
lines changed

README.md

+63
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,75 @@ For the user interface to work, you need to have the following installed on your
1818
- Node.js
1919
- pnpm
2020

21+
### MacOS
22+
2123
Installing everything on macOS using HomeBrew can be done with the following commands:
2224

2325
```
2426
brew install openjdk@17 node pnpm
2527
```
2628

29+
### Windows
30+
31+
Installing JDK:
32+
33+
1. Through Eclipse Adoptium:
34+
35+
- Download the version you need (JDK-21)
36+
- When installing, select "Set or override JAVA_HOME variable"
37+
38+
2. Through Windows Package Manager - "winget":
39+
40+
```
41+
// Eclipse Temurin from Eclipse Adoptium
42+
winget install EclipseAdoptium.Temurin.21.JDK
43+
44+
// from Microsoft Build
45+
winget install Microsoft.OpenJDK.21
46+
```
47+
48+
> [!NOTE]
49+
> You might need to set a PATH and JAVA_HOME!
50+
51+
To verify the installation execute the following in cmd (should match the installed version):
52+
53+
```
54+
java -version
55+
```
56+
57+
> [!NOTE]
58+
> If it displays a different version, then the PATH or JAVA_HOME could be set incorrectly (pointing to another version)!
59+
60+
Installing Node.js:
61+
62+
1. Through installer: https://nodejs.org/en/download/prebuilt-installer
63+
2. Through package managers: https://nodejs.org/en/download/package-manager
64+
65+
To install pnpm, you can use npm package manager (installed alongside Node.js):
66+
67+
```
68+
npm install -g pnpm
69+
```
70+
71+
or Corepack:
72+
73+
```
74+
corepack enable pnpm
75+
```
76+
77+
or PowerShell:
78+
79+
```
80+
Invoke-WebRequest https://get.pnpm.io/install.ps1 -UseBasicParsing | Invoke-Expression
81+
```
82+
83+
> [!WARNING]
84+
> Windows Defender may block this option!
85+
>
86+
> Using npm or Corepack is the recommended way!
87+
88+
Reference: https://pnpm.io/installation
89+
2790
For other operating systems, please refer to the respective installation instructions.
2891

2992
## Building

0 commit comments

Comments
 (0)