Skip to content

Commit

Permalink
chore: align engines and docs with actually supported version (#6023)
Browse files Browse the repository at this point in the history
  • Loading branch information
gribnoysup authored Jul 15, 2024
1 parent 9f98ac8 commit fed1b54
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit fed1b54

Please sign in to comment.