You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,10 +3,10 @@
3
3
4
4
## Getting Started
5
5
6
-
You'll need node `^16` and npm `^8` installed on your machine to work with the repository locally.
6
+
You'll need node `^18` and npm `^10` installed on your machine to work with the repository locally.
7
7
After your environment is ready, navigate to the repository and run `npm run bootstrap`, this will install dependencies and will compile all packages.
8
8
9
-
After bootstrap is finished, you should be able to run `npm run start` and see Compass application running locally.
9
+
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`.
10
10
11
11
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.
12
12
@@ -80,7 +80,7 @@ DEBUG=hadron* npm run package-compass
80
80
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
81
81
82
82
```sh
83
-
HADRON_SKIP_INSTALLER=true npm run test-package-compass
83
+
HADRON_SKIP_INSTALLER=true npm run package-compass
0 commit comments