From ac76e9c7248a15a710e66e168ad0a7b3321b9214 Mon Sep 17 00:00:00 2001 From: Rikhi Singh <114336052+RikhiSingh@users.noreply.github.com> Date: Sat, 7 Dec 2024 07:19:20 -0500 Subject: [PATCH] feat(docs): Add Node setup instructions for nvm to contributing guide - Added a detailed section on using Node Version Manager (nvm) to the contributing guide. - The new section explains how contributors can ensure their Node.js version meets the project's requirements using `nvm`. - Included instructions for installing `nvm`, switching Node versions, and installing specific versions if necessary. This change aims to help contributors quickly set up their environment and avoid potential compatibility issues. --- contributing.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/contributing.md b/contributing.md index dbfb9b5eb8..d38b8d5404 100644 --- a/contributing.md +++ b/contributing.md @@ -45,6 +45,21 @@ You would need [Node v20.x or the latest LTS version](https://nodejs.org/en/) an Bruno is being developed as a desktop app. You need to load the app by running the Next.js app in one terminal and then run the electron app in another terminal. +### Setup Node +If your Node version does not meet the project's requirements as instructed by the docs, "nvm" (Node Version Manager) allows using Node at the version required by the project: + + ```sh + nvm use + ``` + + You first might need to install the specific version: + + ```sh + nvm install + ``` + + You can install nvm from [here](https://github.com/nvm-sh/nvm). + ### Local Development ```bash