Skip to content

Commit 609be8a

Browse files
Update Setup Guide for Windows
1 parent 551e939 commit 609be8a

File tree

1 file changed

+73
-19
lines changed

1 file changed

+73
-19
lines changed

docs/DEV.md

+73-19
Original file line numberDiff line numberDiff line change
@@ -14,31 +14,85 @@ _**ts-node**_ (_Node.js executable for TypeScript_) to manually execute `.ts` sc
1414
you'll need an _HTTP_ server like _**http-server**_ (_a HTTP server program_), if you want to serve
1515
files manually.
1616

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

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

25-
_**Note:**_ Users on _Linux_ and _MacOS_ are required to add a `sudo` before these commands.
21+
1. **Install Node.js and npm**
2622

27-
Check installation using
23+
Download and install **Node.js v16** from [Node.js Official Website](https://nodejs.org/).
24+
Make sure to include the npm package manager when prompted.
2825

29-
```bash
30-
node -v && npm -v && tsc -v && ts-node -v && http-server -v
31-
```
26+
_**Note:**_ For Windows users, ensure PowerShell’s execution policy allows running scripts by
27+
setting it to `RemoteSigned` if necessary: `Set-ExecutionPolicy RemoteSigned -Scope CurrentUser`.
28+
If you run into issues, please refer to [this page](https://stackoverflow.com/questions/4037939/powershell-says-execution-of-scripts-is-disabled-on-this-system).
3229

33-
Output should look like
30+
2. **Install Required Global Packages**
3431

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

4397
### With Docker
4498

0 commit comments

Comments
 (0)