Skip to content

Commit 49256d1

Browse files
Update Setup Guide for Windows
1 parent 551e939 commit 49256d1

File tree

1 file changed

+65
-19
lines changed

1 file changed

+65
-19
lines changed

docs/DEV.md

+65-19
Original file line numberDiff line numberDiff line change
@@ -14,31 +14,77 @@ _**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/). Make sure to include the npm package manager when prompted.
2824

29-
```bash
30-
node -v && npm -v && tsc -v && ts-node -v && http-server -v
31-
```
25+
_**Note:**_ For Windows users, ensure PowerShell’s execution policy allows running scripts by setting it to `RemoteSigned` if necessary: `Set-ExecutionPolicy RemoteSigned -Scope CurrentUser`. 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).
3226

33-
Output should look like
27+
2. **Install Required Global Packages**
3428

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

4389
### With Docker
4490

0 commit comments

Comments
 (0)