Skip to content

Commit

Permalink
docs: add more info to getting started (#391)
Browse files Browse the repository at this point in the history
* docs: specify nodejs version requirement;

* docs: clone using HTTPS;

* docs: include webpack watch command;
  • Loading branch information
uFloppyDisk authored Feb 12, 2025
1 parent ceb11c2 commit 90308d2
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,26 @@

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

### Prerequisites

**NodeJS v22 or v20 must be installed.**\
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`)
<details>
<summary>
Get NodeJS v22 with nvm
</summary>

```shell
nvm install 22 && nvm use 22
```
</details>

### Install and setup

Clone this repository:

```shell
git clone git@github.com:aradzie/keybr.com.git
git clone https://github.com/aradzie/keybr.com.git
cd keybr.com
```

Expand Down Expand Up @@ -43,3 +59,11 @@ npm start
```

With the default config the application should be accessible at [http://localhost:3000/](http://localhost:3000/)

While actively developing, you may want your changes to be automatically built and
visible on page refresh.\
Run the following command at the same time as `npm start` in another shell:

```shell
npm run watch
```

0 comments on commit 90308d2

Please sign in to comment.