From df16a0fe1bbec0414bd19e29c0669eee194e9cf1 Mon Sep 17 00:00:00 2001 From: Sergey Petushkov Date: Mon, 15 Jul 2024 11:56:52 +0200 Subject: [PATCH] chore: align engines and docs with actually supported version --- CONTRIBUTING.md | 6 +++--- package-lock.json | 4 ++-- package.json | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e4d9c53ebbf..eb110cfc9a7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,10 +3,10 @@ ## Getting Started -You'll need node `^16` and npm `^8` installed on your machine to work with the repository locally. +You'll need node `^18` and npm `^10` installed on your machine to work with the repository locally. After your environment is ready, navigate to the repository and run `npm run bootstrap`, this will install dependencies and will compile all packages. -After bootstrap is finished, you should be able to run `npm run start` and see Compass application running locally. +After bootstrap is finished, you should be able to run `npm run start` and see Compass application running locally. Alternatively you can start a web version of the app by running `npm run start-web`. Compass uses a monorepo is powered by [`npm workspaces`](https://docs.npmjs.com/cli/v7/using-npm/workspaces) and [`lerna`](https://github.com/lerna/lerna#readme), although not necessary, it might be helpful to have a high level understanding of those tools. @@ -80,7 +80,7 @@ DEBUG=hadron* npm run package-compass To speed up the process you might want to disable creating installer for the application. To do that you can set `HADRON_SKIP_INSTALLER` environmental variable to `true` when running the script ```sh -HADRON_SKIP_INSTALLER=true npm run test-package-compass +HADRON_SKIP_INSTALLER=true npm run package-compass ``` ### Publishing Packages diff --git a/package-lock.json b/package-lock.json index 4fb9fc1a429..f6f5b1ecf1c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -25,8 +25,8 @@ "node-gyp": "^8.4.1" }, "engines": { - "node": ">=16.15.1", - "npm": ">=8.19.4" + "node": ">=18.19.1", + "npm": ">=10.2.4" } }, "configs/eslint-config-compass": { diff --git a/package.json b/package.json index 3609160b370..a4d33fab268 100644 --- a/package.json +++ b/package.json @@ -79,8 +79,8 @@ "node-gyp": "^8.4.1" }, "engines": { - "node": ">=16.15.1", - "npm": ">=8.19.4" + "node": ">=18.19.1", + "npm": ">=10.2.4" }, "bugs": { "url": "https://docs.mongodb.com/compass/current/#contact",