Skip to content

Commit 7a43c34

Browse files
Update Setup Guide for Windows
1 parent 551e939 commit 7a43c34

File tree

1 file changed

+60
-19
lines changed

1 file changed

+60
-19
lines changed

docs/DEV.md

+60-19
Original file line numberDiff line numberDiff line change
@@ -9,36 +9,77 @@ _[**Node.js**](https://nodejs.org/en) v16_ and _**npm**_ installed on your devel
99
Although, this is sufficient to run, build, and test the project as a whole, you might need some
1010
extra tools for other development tasks.
1111

12+
_**Note:**_ For Windows users, ensure PowerShell’s execution policy allows running scripts by
13+
setting it to `RemoteSigned` if necessary: `Set-ExecutionPolicy RemoteSigned -Scope CurrentUser`. If
14+
you run into issues, please refer to [this page](https://stackoverflow.com/questions/4037939/powershell-says-execution-of-scripts-is-disabled-on-this-system).
15+
1216
You'll need _**tsc**_ (_TypeScript Compiler_) to manually compile `.ts` files. You'll need
1317
_**ts-node**_ (_Node.js executable for TypeScript_) to manually execute `.ts` scripts directly. Finally,
1418
you'll need an _HTTP_ server like _**http-server**_ (_a HTTP server program_), if you want to serve
1519
files manually.
1620

17-
Once _**npm**_ is installed, to install the above, run
21+
### Installation Steps
1822

19-
```bash
20-
npm i -g http-server
21-
npm i -g typescript
22-
npm i -g ts-node
23-
```
23+
#### Install Prequisites
2424

25-
_**Note:**_ Users on _Linux_ and _MacOS_ are required to add a `sudo` before these commands.
25+
1. **Install Required Global Packages**
2626

27-
Check installation using
27+
Run the following commands:
2828

29-
```bash
30-
node -v && npm -v && tsc -v && ts-node -v && http-server -v
31-
```
29+
```bash
30+
npm i -g http-server
31+
npm i -g typescript
32+
npm i -g ts-node
33+
```
3234

33-
Output should look like
35+
_**Note:**_ Users on _Linux_ and _MacOS_ are required to add a `sudo` before these commands.
3436

35-
```bash
36-
v16.14.0
37-
8.3.1
38-
Version 4.6.2
39-
v10.6.0
40-
v14.1.0
41-
```
37+
```bash
38+
sudo npm i -g typescript ts-node http-server
39+
```
40+
41+
These global packages are _not required by the app_ but serve as extra utilities.
42+
43+
2. **Verify Installation**
44+
45+
Ensure all tools are installed correctly by running:
46+
47+
```bash
48+
node -v && npm -v && tsc -v && ts-node -v && http-server -v
49+
```
50+
51+
_**Note:**_ For _Windows OS_, this works only in **PowerShell 7+ (Core)**, not in Windows PowerShell
52+
(v5.1 or earlier). To check your powershell version, run `$PSVersionTable` in the integrated terminal.
53+
If outdated (below 7.0), run `winget install --id Microsoft.Powershell --source winget` to update.
54+
If `winget` is unavailable, download the latest `.msi` installer from the official
55+
[PowerShell GitHub releases](https://github.com/PowerShell/PowerShell/releases)
56+
based on your system architecture.
57+
58+
Expected output (versions may vary slightly):
59+
60+
```bash
61+
v16.14.0
62+
8.3.1
63+
Version 4.6.2
64+
v10.6.0
65+
v14.1.0
66+
```
67+
68+
#### Getting the code
69+
70+
1. Fork this repository
71+
72+
2. Clone your forked copy of Music Blocks (v4) for _HTTPS_ on your local machine:
73+
74+
```bash
75+
git clone https://github.com/<your_user_name>/musicblocks-v4.git
76+
```
77+
78+
3. Navigate to the cloned repository:
79+
80+
```bash
81+
cd musicblocks-v4
82+
```
4283

4384
### With Docker
4485

0 commit comments

Comments
 (0)