From 992ced423de406ebcd2eee2c0cdc2f9bb8abf910 Mon Sep 17 00:00:00 2001 From: Edwin Hoogerbeets Date: Tue, 4 Feb 2025 09:37:55 -0800 Subject: [PATCH] minor whitespace edits to setup --- SETUP.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/SETUP.md b/SETUP.md index d448b596e..09972072a 100644 --- a/SETUP.md +++ b/SETUP.md @@ -1,41 +1,54 @@ ## Setup + ### Prerequisites + This project is developed using Node.js, nvm and pnpm. Make sure you've got them installed in correct versions before continuing. Versions used for development: + - Node.js: version specified in `.nvmrc` file - pnpm: version specified in `package.json` file You can find installation instructions at: + - [nodejs.org](https://nodejs.org/) - [github.com/nvm-sh/nvm](https://github.com/nvm-sh/nvm) - [pnpm.io/](https://pnpm.io/) ### Repository clone + Clone the repository to your local machine with HTTPS: + ```bash git clone https://github.com/iLib-js/ilib-mono.git ``` + or with SSH: + ```bash git clone git@github.com:iLib-js/ilib-mono.git ```` Navigate to the project root directory: + ```bash cd ilib-mono ``` + Every command from now on should be run in the root directory of the project, unless stated otherwise. ### Installation + Once Node.js, nvm and pnpm are installed, you can continue with the following steps. #### 1. Installing project specific Node.js version + Install and use Node.js version specified in `ilib-mono/.nvmrc` file. Run: + ```bash nvm use ``` @@ -43,8 +56,10 @@ nvm use Optional: You can add automated `nvm use` to shell profile. See guide [here](https://github.com/nvm-sh/nvm?tab=readme-ov-file#zsh). #### 2. Enabling pnpm + Since v16.13, Node.js is shipping [Corepack](https://nodejs.org/api/corepack.html) for managing package managers, so you do not need to install pnpm separately. However, this is an experimental feature, so you need to enable it by running: + ```bash corepack enable pnpm ``` @@ -52,7 +67,9 @@ corepack enable pnpm Optional: `pnpm` might be hard to type, so you may use a shorter alias like `pn` instead. See guide [here](https://pnpm.io/installation#using-a-shorter-alias). #### 3. Installing project dependencies + The final step is to install the project dependencies. Run: + ```bash pnpm install ```