From aaf4a51e71c4625ce842d859655e13b77d3d3ae6 Mon Sep 17 00:00:00 2001 From: Jannis R Date: Wed, 16 Nov 2022 12:28:04 +0100 Subject: [PATCH 1/2] =?UTF-8?q?installation=20docs:=20link=20to=20Node.js,?= =?UTF-8?q?=20recommend=20nvm=20=F0=9F=93=9D?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/Installation.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/Installation.md b/docs/Installation.md index a0b922a127..3d584cbd52 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -2,9 +2,12 @@ - [Run application in Docker](Docker.md). ## Install requirements -You need Node, yarn (or npm3) and watchman. -- `node -v` should be >= 10.19. There might be problems it is 12 or above +You need [Node](https://nodejs.org/), [Yarn](https://yarnpkg.com) (or npm) and watchman. + +- `node -v` should be >= 10.19. + - We recommend that you use [`nvm`](https://github.com/nvm-sh/nvm) to install a specific Node.js version. + - With Node.js versions >= 12, there might be problems. - `yarn --version` should be >= 1.22.0. The project will then use yarn 2 from the included file. (or `npm -v` should be >= 3) You also need a C compiler: From 81dabf42ccd37cb5ea50078e4e646593556ba13d Mon Sep 17 00:00:00 2001 From: Jannis R Date: Wed, 16 Nov 2022 12:22:47 +0100 Subject: [PATCH 2/2] =?UTF-8?q?add=20.nvmrc=20to=20aid=20with=20using=20th?= =?UTF-8?q?e=20right=20Node.js=20version=20=F0=9F=93=9D?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .nvmrc | 1 + docs/Installation.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) create mode 100644 .nvmrc diff --git a/.nvmrc b/.nvmrc new file mode 100644 index 0000000000..958b5a36e1 --- /dev/null +++ b/.nvmrc @@ -0,0 +1 @@ +v14 diff --git a/docs/Installation.md b/docs/Installation.md index 3d584cbd52..7fe162c506 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -6,7 +6,7 @@ You need [Node](https://nodejs.org/), [Yarn](https://yarnpkg.com) (or npm) and watchman. - `node -v` should be >= 10.19. - - We recommend that you use [`nvm`](https://github.com/nvm-sh/nvm) to install a specific Node.js version. + - We recommend that you use [`nvm`](https://github.com/nvm-sh/nvm) to install a specific Node.js version. Optionally, you can also set up [its automatic version switching shell integration](https://github.com/nvm-sh/nvm/tree/e6fa80cb6178ff4e9735265281b5eae811f05f11#deeper-shell-integration). - With Node.js versions >= 12, there might be problems. - `yarn --version` should be >= 1.22.0. The project will then use yarn 2 from the included file. (or `npm -v` should be >= 3)