Skip to content

Commit 90308d2

Browse files
authored
docs: add more info to getting started (#391)
* docs: specify nodejs version requirement; * docs: clone using HTTPS; * docs: include webpack watch command;
1 parent ceb11c2 commit 90308d2

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

docs/getting_started.md

+25-1
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,26 @@
22

33
This is a [nodejs](https://nodejs.org/) application, so proficiency with the node ecosystem is required.
44

5+
### Prerequisites
6+
7+
**NodeJS v22 or v20 must be installed.**\
8+
You can get NodeJS v22 or v20 without impacting other Node installations using [Node Version Manager](https://github.com/nvm-sh/nvm?tab=readme-ov-file#installing-and-updating) (`nvm`)
9+
<details>
10+
<summary>
11+
Get NodeJS v22 with nvm
12+
</summary>
13+
14+
```shell
15+
nvm install 22 && nvm use 22
16+
```
17+
</details>
18+
19+
### Install and setup
20+
521
Clone this repository:
622

723
```shell
8-
git clone git@github.com:aradzie/keybr.com.git
24+
git clone https://github.com/aradzie/keybr.com.git
925
cd keybr.com
1026
```
1127

@@ -43,3 +59,11 @@ npm start
4359
```
4460

4561
With the default config the application should be accessible at [http://localhost:3000/](http://localhost:3000/)
62+
63+
While actively developing, you may want your changes to be automatically built and
64+
visible on page refresh.\
65+
Run the following command at the same time as `npm start` in another shell:
66+
67+
```shell
68+
npm run watch
69+
```

0 commit comments

Comments
 (0)