Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: align engines and docs with actually supported version #6023

Merged
merged 1 commit into from
Jul 15, 2024
Merged

chore: align engines and docs with actually supported version #6023

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
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
View file
Open in desktop

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
View file
Open in desktop
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
Loading